Generic SmartRest library
Dependents: SmartRestUnitTest MbedSmartRest MbedSmartRestStreaming
Record.h@0:744801d5734d, 2014-03-24 (annotated)
- Committer:
- vwochnik
- Date:
- Mon Mar 24 09:57:40 2014 +0000
- Revision:
- 0:744801d5734d
fix;
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
vwochnik | 0:744801d5734d | 1 | /* |
vwochnik | 0:744801d5734d | 2 | * Record.h |
vwochnik | 0:744801d5734d | 3 | * |
vwochnik | 0:744801d5734d | 4 | * Created on: Nov 1, 2013 |
vwochnik | 0:744801d5734d | 5 | * * Authors: Vincent Wochnik <v.wochnik@gmail.com> |
vwochnik | 0:744801d5734d | 6 | * |
vwochnik | 0:744801d5734d | 7 | * Copyright (c) 2013 Cumulocity GmbH |
vwochnik | 0:744801d5734d | 8 | * |
vwochnik | 0:744801d5734d | 9 | * Permission is hereby granted, free of charge, to any person obtaining |
vwochnik | 0:744801d5734d | 10 | * a copy of this software and associated documentation files (the |
vwochnik | 0:744801d5734d | 11 | * "Software"), to deal in the Software without restriction, including |
vwochnik | 0:744801d5734d | 12 | * without limitation the rights to use, copy, modify, merge, publish, |
vwochnik | 0:744801d5734d | 13 | * distribute, sublicense, and/or sell copies of the Software, and to |
vwochnik | 0:744801d5734d | 14 | * permit persons to whom the Software is furnished to do so, subject to |
vwochnik | 0:744801d5734d | 15 | * the following conditions: |
vwochnik | 0:744801d5734d | 16 | * |
vwochnik | 0:744801d5734d | 17 | * The above copyright notice and this permission notice shall be |
vwochnik | 0:744801d5734d | 18 | * included in all copies or substantial portions of the Software. |
vwochnik | 0:744801d5734d | 19 | * |
vwochnik | 0:744801d5734d | 20 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
vwochnik | 0:744801d5734d | 21 | * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
vwochnik | 0:744801d5734d | 22 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
vwochnik | 0:744801d5734d | 23 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE |
vwochnik | 0:744801d5734d | 24 | * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION |
vwochnik | 0:744801d5734d | 25 | * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION |
vwochnik | 0:744801d5734d | 26 | * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
vwochnik | 0:744801d5734d | 27 | */ |
vwochnik | 0:744801d5734d | 28 | |
vwochnik | 0:744801d5734d | 29 | #ifndef RECORD_H |
vwochnik | 0:744801d5734d | 30 | #define RECORD_H |
vwochnik | 0:744801d5734d | 31 | |
vwochnik | 0:744801d5734d | 32 | #ifdef HAVE_CONFIG_H |
vwochnik | 0:744801d5734d | 33 | #include <config.h> |
vwochnik | 0:744801d5734d | 34 | #endif |
vwochnik | 0:744801d5734d | 35 | |
vwochnik | 0:744801d5734d | 36 | #include "DataGenerator.h" |
vwochnik | 0:744801d5734d | 37 | #include "Value.h" |
vwochnik | 0:744801d5734d | 38 | |
vwochnik | 0:744801d5734d | 39 | /** |
vwochnik | 0:744801d5734d | 40 | * A record which can be read and serialized. |
vwochnik | 0:744801d5734d | 41 | */ |
vwochnik | 0:744801d5734d | 42 | class Record : public DataGenerator |
vwochnik | 0:744801d5734d | 43 | { |
vwochnik | 0:744801d5734d | 44 | public: |
vwochnik | 0:744801d5734d | 45 | virtual ~Record() { }; |
vwochnik | 0:744801d5734d | 46 | |
vwochnik | 0:744801d5734d | 47 | /** |
vwochnik | 0:744801d5734d | 48 | * Returns the number of values in this record. |
vwochnik | 0:744801d5734d | 49 | * @return number of values in this record |
vwochnik | 0:744801d5734d | 50 | */ |
vwochnik | 0:744801d5734d | 51 | virtual size_t values() const = 0; |
vwochnik | 0:744801d5734d | 52 | |
vwochnik | 0:744801d5734d | 53 | /** |
vwochnik | 0:744801d5734d | 54 | * Returns the value object by index |
vwochnik | 0:744801d5734d | 55 | * @param index the index of the value |
vwochnik | 0:744801d5734d | 56 | * @return a copy of a value object |
vwochnik | 0:744801d5734d | 57 | */ |
vwochnik | 0:744801d5734d | 58 | virtual const Value& value(size_t index) const = 0; |
vwochnik | 0:744801d5734d | 59 | |
vwochnik | 0:744801d5734d | 60 | size_t writeTo(AbstractDataSink&) const; |
vwochnik | 0:744801d5734d | 61 | size_t writtenLength() const; |
vwochnik | 0:744801d5734d | 62 | |
vwochnik | 0:744801d5734d | 63 | operator bool() const; |
vwochnik | 0:744801d5734d | 64 | }; |
vwochnik | 0:744801d5734d | 65 | |
vwochnik | 0:744801d5734d | 66 | #endif |