mbed.org implementation of the abstract SmartREST library for the Cumulocity Platform SmartREST protocol.
Dependents: MbedSmartRestMain MbedSmartRestMain
ParsedRecord.h@0:099f76422485, 2014-07-03 (annotated)
- Committer:
- Cumulocity
- Date:
- Thu Jul 03 20:38:04 2014 +0200
- Revision:
- 0:099f76422485
- Child:
- 4:059b8b90e0d9
Updated from revision 0413a0179eb6
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
Cumulocity | 0:099f76422485 | 1 | /* |
Cumulocity | 0:099f76422485 | 2 | * ParsedRecord.h |
Cumulocity | 0:099f76422485 | 3 | * |
Cumulocity | 0:099f76422485 | 4 | * Created on: Nov 1, 2013 |
Cumulocity | 0:099f76422485 | 5 | * * Authors: Vincent Wochnik <v.wochnik@gmail.com> |
Cumulocity | 0:099f76422485 | 6 | * |
Cumulocity | 0:099f76422485 | 7 | * Copyright (c) 2013 Cumulocity GmbH |
Cumulocity | 0:099f76422485 | 8 | * |
Cumulocity | 0:099f76422485 | 9 | * Permission is hereby granted, free of charge, to any person obtaining |
Cumulocity | 0:099f76422485 | 10 | * a copy of this software and associated documentation files (the |
Cumulocity | 0:099f76422485 | 11 | * "Software"), to deal in the Software without restriction, including |
Cumulocity | 0:099f76422485 | 12 | * without limitation the rights to use, copy, modify, merge, publish, |
Cumulocity | 0:099f76422485 | 13 | * distribute, sublicense, and/or sell copies of the Software, and to |
Cumulocity | 0:099f76422485 | 14 | * permit persons to whom the Software is furnished to do so, subject to |
Cumulocity | 0:099f76422485 | 15 | * the following conditions: |
Cumulocity | 0:099f76422485 | 16 | * |
Cumulocity | 0:099f76422485 | 17 | * The above copyright notice and this permission notice shall be |
Cumulocity | 0:099f76422485 | 18 | * included in all copies or substantial portions of the Software. |
Cumulocity | 0:099f76422485 | 19 | * |
Cumulocity | 0:099f76422485 | 20 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
Cumulocity | 0:099f76422485 | 21 | * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
Cumulocity | 0:099f76422485 | 22 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
Cumulocity | 0:099f76422485 | 23 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE |
Cumulocity | 0:099f76422485 | 24 | * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION |
Cumulocity | 0:099f76422485 | 25 | * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION |
Cumulocity | 0:099f76422485 | 26 | * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
Cumulocity | 0:099f76422485 | 27 | */ |
Cumulocity | 0:099f76422485 | 28 | |
Cumulocity | 0:099f76422485 | 29 | #ifndef PARSEDRECORD_H |
Cumulocity | 0:099f76422485 | 30 | #define PARSEDRECORD_H |
Cumulocity | 0:099f76422485 | 31 | |
Cumulocity | 0:099f76422485 | 32 | #include "config.h" |
Cumulocity | 0:099f76422485 | 33 | #include "DataGenerator.h" |
Cumulocity | 0:099f76422485 | 34 | #include "Record.h" |
Cumulocity | 0:099f76422485 | 35 | #include "Value.h" |
Cumulocity | 0:099f76422485 | 36 | |
Cumulocity | 0:099f76422485 | 37 | #ifndef SMARTREST_PARSED_DYNAMIC_ALLOC |
Cumulocity | 0:099f76422485 | 38 | #ifndef SMARTREST_PARSED_FIXED_SIZE |
Cumulocity | 0:099f76422485 | 39 | #define SMARTREST_PARSED_FIXED_SIZE 24 |
Cumulocity | 0:099f76422485 | 40 | #endif |
Cumulocity | 0:099f76422485 | 41 | #endif |
Cumulocity | 0:099f76422485 | 42 | |
Cumulocity | 0:099f76422485 | 43 | class Parser; |
Cumulocity | 0:099f76422485 | 44 | |
Cumulocity | 0:099f76422485 | 45 | /** |
Cumulocity | 0:099f76422485 | 46 | * This class provides accessors for values in a parsed record. |
Cumulocity | 0:099f76422485 | 47 | * |
Cumulocity | 0:099f76422485 | 48 | * Example: |
Cumulocity | 0:099f76422485 | 49 | * @code |
Cumulocity | 0:099f76422485 | 50 | * // given a concrete SmartRest client instance |
Cumulocity | 0:099f76422485 | 51 | * SmartRest client; |
Cumulocity | 0:099f76422485 | 52 | |
Cumulocity | 0:099f76422485 | 53 | * ParsedRecord record; |
Cumulocity | 0:099f76422485 | 54 | * if (client.receive(record) == SMARTREST_SUCCESS) { |
Cumulocity | 0:099f76422485 | 55 | * for (size_ i = 0; i < record.values(); i++) { |
Cumulocity | 0:099f76422485 | 56 | * const Value& val = record.value(i); |
Cumulocity | 0:099f76422485 | 57 | * switch (val.valueType()) { |
Cumulocity | 0:099f76422485 | 58 | * case VALUE_NULL: |
Cumulocity | 0:099f76422485 | 59 | * printf("Null value.\n"); |
Cumulocity | 0:099f76422485 | 60 | * break; |
Cumulocity | 0:099f76422485 | 61 | * case VALUE_CHARACTER: |
Cumulocity | 0:099f76422485 | 62 | * printf("Character value: %s\n", val.characterValue()); |
Cumulocity | 0:099f76422485 | 63 | * break; |
Cumulocity | 0:099f76422485 | 64 | * case VALUE_INTEGER: |
Cumulocity | 0:099f76422485 | 65 | * printf("Integer value: %d\n", val.integerValue()); |
Cumulocity | 0:099f76422485 | 66 | * break; |
Cumulocity | 0:099f76422485 | 67 | * case VALUE_FLOAT: |
Cumulocity | 0:099f76422485 | 68 | * printf("Float value: %lf\n", val.floatValue()); |
Cumulocity | 0:099f76422485 | 69 | * break; |
Cumulocity | 0:099f76422485 | 70 | * } |
Cumulocity | 0:099f76422485 | 71 | * } |
Cumulocity | 0:099f76422485 | 72 | * } |
Cumulocity | 0:099f76422485 | 73 | * @encode |
Cumulocity | 0:099f76422485 | 74 | */ |
Cumulocity | 0:099f76422485 | 75 | class ParsedRecord : public Record |
Cumulocity | 0:099f76422485 | 76 | { |
Cumulocity | 0:099f76422485 | 77 | public: |
Cumulocity | 0:099f76422485 | 78 | ParsedRecord(); |
Cumulocity | 0:099f76422485 | 79 | ~ParsedRecord(); |
Cumulocity | 0:099f76422485 | 80 | |
Cumulocity | 0:099f76422485 | 81 | size_t values() const; |
Cumulocity | 0:099f76422485 | 82 | const Value& value(size_t index) const; |
Cumulocity | 0:099f76422485 | 83 | |
Cumulocity | 0:099f76422485 | 84 | DataGenerator* copy() const; |
Cumulocity | 0:099f76422485 | 85 | |
Cumulocity | 0:099f76422485 | 86 | /** |
Cumulocity | 0:099f76422485 | 87 | * Returns the raw value string by index |
Cumulocity | 0:099f76422485 | 88 | * @param index the index of the value |
Cumulocity | 0:099f76422485 | 89 | * @return a pointer to the raw value |
Cumulocity | 0:099f76422485 | 90 | */ |
Cumulocity | 0:099f76422485 | 91 | const char * rawValue(size_t index) const; |
Cumulocity | 0:099f76422485 | 92 | |
Cumulocity | 0:099f76422485 | 93 | protected: |
Cumulocity | 0:099f76422485 | 94 | void set(const char*, size_t); |
Cumulocity | 0:099f76422485 | 95 | void clear(); |
Cumulocity | 0:099f76422485 | 96 | |
Cumulocity | 0:099f76422485 | 97 | private: |
Cumulocity | 0:099f76422485 | 98 | #ifdef SMARTREST_PARSED_DYNAMIC_ALLOC |
Cumulocity | 0:099f76422485 | 99 | const Value **_values; |
Cumulocity | 0:099f76422485 | 100 | #else |
Cumulocity | 0:099f76422485 | 101 | const Value *_values[SMARTREST_PARSED_FIXED_SIZE]; |
Cumulocity | 0:099f76422485 | 102 | #endif |
Cumulocity | 0:099f76422485 | 103 | const char *_buffer; |
Cumulocity | 0:099f76422485 | 104 | size_t _count; |
Cumulocity | 0:099f76422485 | 105 | |
Cumulocity | 0:099f76422485 | 106 | friend class Parser; |
Cumulocity | 0:099f76422485 | 107 | }; |
Cumulocity | 0:099f76422485 | 108 | |
Cumulocity | 0:099f76422485 | 109 | |
Cumulocity | 0:099f76422485 | 110 | #endif |