Cumulocity Official / MbedSmartRest

mbed.org implementation of the abstract SmartREST library for the Cumulocity Platform SmartREST protocol.

Dependents:   MbedSmartRestMain MbedSmartRestMain

Record.h@13:aba98ad2ac1b, 2014-11-15 (annotated)

Committer:
Cumulocity
Date:
Sat Nov 15 12:21:41 2014 +0100
Revision:
13:aba98ad2ac1b
Parent:
11:e1bee9a77652 
Updated from revision 0b898f0efc6d

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Cumulocity 0:099f76422485 1 /*
Cumulocity 0:099f76422485 2 * Record.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 RECORD_H
Cumulocity 0:099f76422485 30 #define RECORD_H
Cumulocity 0:099f76422485 31
Cumulocity 0:099f76422485 32 #include "config.h"
Cumulocity 0:099f76422485 33 #include "DataGenerator.h"
Cumulocity 0:099f76422485 34 #include "Value.h"
Cumulocity 0:099f76422485 35
Cumulocity 0:099f76422485 36 /**
Cumulocity 0:099f76422485 37 * A record which can be read and serialized.
Cumulocity 0:099f76422485 38 */
Cumulocity 0:099f76422485 39 class Record : public DataGenerator
Cumulocity 0:099f76422485 40 {
Cumulocity 11:e1bee9a77652 41 public:
Cumulocity 11:e1bee9a77652 42 virtual ~Record() { };
Cumulocity 0:099f76422485 43
Cumulocity 11:e1bee9a77652 44 /**
Cumulocity 11:e1bee9a77652 45 * Returns the number of values in this record.
Cumulocity 11:e1bee9a77652 46 * @return number of values in this record
Cumulocity 11:e1bee9a77652 47 */
Cumulocity 11:e1bee9a77652 48 virtual size_t values() const = 0;
Cumulocity 0:099f76422485 49
Cumulocity 11:e1bee9a77652 50 /**
Cumulocity 11:e1bee9a77652 51 * Returns the value object by index
Cumulocity 11:e1bee9a77652 52 * @param index the index of the value
Cumulocity 11:e1bee9a77652 53 * @return a copy of a value object
Cumulocity 11:e1bee9a77652 54 */
Cumulocity 11:e1bee9a77652 55 virtual const Value& value(size_t) const = 0;
Cumulocity 0:099f76422485 56
Cumulocity 11:e1bee9a77652 57 size_t writeTo(AbstractDataSink&) const;
Cumulocity 11:e1bee9a77652 58 size_t writtenLength() const;
Cumulocity 0:099f76422485 59
Cumulocity 11:e1bee9a77652 60 virtual Record* copy() const = 0;
Cumulocity 4:059b8b90e0d9 61
Cumulocity 11:e1bee9a77652 62 /**
Cumulocity 11:e1bee9a77652 63 * Test if record contains any values.
Cumulocity 11:e1bee9a77652 64 */
Cumulocity 11:e1bee9a77652 65 operator bool() const;
Cumulocity 0:099f76422485 66 };
Cumulocity 0:099f76422485 67
Cumulocity 0:099f76422485 68 #endif