Cumulocity Official / MbedSmartRest

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

Dependents:   MbedSmartRestMain MbedSmartRestMain

ComposedRecord.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 * ComposedRecord.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 COMPOSEDRECORD_H
Cumulocity 0:099f76422485 30 #define COMPOSEDRECORD_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_COMPOSED_INITIAL_CAPACITY
Cumulocity 0:099f76422485 38 #define SMARTREST_COMPOSED_INITIAL_CAPACITY 10
Cumulocity 0:099f76422485 39 #endif
Cumulocity 0:099f76422485 40 #ifndef SMARTREST_COMPOSED_MEMORY_INCREMENT
Cumulocity 0:099f76422485 41 #define SMARTREST_COMPOSED_MEMORY_INCREMENT 5
Cumulocity 0:099f76422485 42 #endif
Cumulocity 0:099f76422485 43 //#define SMARTREST_COMPOSED_FIXED_SIZE 25
Cumulocity 0:099f76422485 44
Cumulocity 0:099f76422485 45 /**
Cumulocity 0:099f76422485 46 * This value set collects values and serializes them into a SmartRequest.
Cumulocity 0:099f76422485 47 *
Cumulocity 0:099f76422485 48 * Example 1 (low memory usage):
Cumulocity 0:099f76422485 49 * @code
Cumulocity 0:099f76422485 50 * // this record does not copy added values into the heap because the
Cumulocity 0:099f76422485 51 * // lifetime of the instance does not exceed the lifetime of its added
Cumulocity 0:099f76422485 52 * // values.
Cumulocity 0:099f76422485 53 * ComposedRecord record(false);
Cumulocity 0:099f76422485 54 * IntegerValue msgId(100);
Cumulocity 0:099f76422485 55 * CharValue str("Hello World!");
Cumulocity 0:099f76422485 56 * FloatValue num(3.1415, 2);
Cumulocity 0:099f76422485 57 * record.add(msgId).add(str).add(num);
Cumulocity 0:099f76422485 58 * @encode
Cumulocity 0:099f76422485 59 *
Cumulocity 0:099f76422485 60 * Example 2 (short form):
Cumulocity 0:099f76422485 61 * @code
Cumulocity 0:099f76422485 62 * // this record needs to copy added values due to the limited
Cumulocity 0:099f76422485 63 * // lifetime of temporary objects.
Cumulocity 0:099f76422485 64 * ComposedRecord record(true);
Cumulocity 0:099f76422485 65 * record.add(IntegerValue(100)).add(CharValue("Hello World!");
Cumulocity 0:099f76422485 66 * record.add(FloatValue(3.1415, 2));
Cumulocity 0:099f76422485 67 * @encode
Cumulocity 0:099f76422485 68 */
Cumulocity 0:099f76422485 69 class ComposedRecord : public Record
Cumulocity 0:099f76422485 70 {
Cumulocity 11:e1bee9a77652 71 public:
Cumulocity 11:e1bee9a77652 72 ComposedRecord(bool = false);
Cumulocity 11:e1bee9a77652 73 ~ComposedRecord();
Cumulocity 0:099f76422485 74
Cumulocity 11:e1bee9a77652 75 bool add(const Value&);
Cumulocity 11:e1bee9a77652 76 void clear();
Cumulocity 0:099f76422485 77
Cumulocity 11:e1bee9a77652 78 size_t values() const;
Cumulocity 11:e1bee9a77652 79 const Value& value(size_t) const;
Cumulocity 0:099f76422485 80
Cumulocity 11:e1bee9a77652 81 ComposedRecord* copy() const;
Cumulocity 0:099f76422485 82
Cumulocity 11:e1bee9a77652 83 private:
Cumulocity 11:e1bee9a77652 84 #ifndef SMARTREST_COMPOSED_FIXED_SIZE
Cumulocity 11:e1bee9a77652 85 const Value **_values;
Cumulocity 11:e1bee9a77652 86 size_t _capacity;
Cumulocity 11:e1bee9a77652 87 #else
Cumulocity 11:e1bee9a77652 88 const Value *_values[SMARTREST_COMPOSED_FIXED_SIZE];
Cumulocity 11:e1bee9a77652 89 #endif
Cumulocity 11:e1bee9a77652 90 size_t _count;
Cumulocity 11:e1bee9a77652 91 bool _alloc;
Cumulocity 0:099f76422485 92 };
Cumulocity 0:099f76422485 93
Cumulocity 0:099f76422485 94 #endif