Cumulocity Official / MbedSmartRest

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

Dependents:   MbedSmartRestMain MbedSmartRestMain

CharValue.h@5:2b74510900da, 2014-07-10 (annotated)

Committer:
Cumulocity
Date:
Thu Jul 10 16:20:31 2014 +0200
Revision:
5:2b74510900da
Parent:
0:099f76422485
Child:
7:8159a2d12e4e
Updated from revision 131b98d7d1aa

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Cumulocity 0:099f76422485 1 /*
Cumulocity 0:099f76422485 2 * CharValue.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 CHARVALUE_H
Cumulocity 0:099f76422485 30 #define CHARVALUE_H
Cumulocity 0:099f76422485 31
Cumulocity 0:099f76422485 32 #include "config.h"
Cumulocity 0:099f76422485 33 #include "Value.h"
Cumulocity 0:099f76422485 34
Cumulocity 0:099f76422485 35 /**
Cumulocity 0:099f76422485 36 * A basic character value. This value type behaves simmilar to a null
Cumulocity 0:099f76422485 37 * value if the ommitted string is empty.
Cumulocity 0:099f76422485 38 *
Cumulocity 0:099f76422485 39 * Example:
Cumulocity 0:099f76422485 40 * @code
Cumulocity 0:099f76422485 41 * // A string
Cumulocity 0:099f76422485 42 * CharValue str("Hello World!");
Cumulocity 0:099f76422485 43 *
Cumulocity 0:099f76422485 44 * // a null value
Cumulocity 0:099f76422485 45 * CharValue null("");
Cumulocity 0:099f76422485 46 *
Cumulocity 0:099f76422485 47 * // another null value
Cumulocity 0:099f76422485 48 * CharValue null2(NULL);
Cumulocity 0:099f76422485 49 * @encode
Cumulocity 0:099f76422485 50 */
Cumulocity 0:099f76422485 51 class CharValue : public Value
Cumulocity 0:099f76422485 52 {
Cumulocity 0:099f76422485 53 public:
Cumulocity 5:2b74510900da 54 CharValue(const char*, bool = false);
Cumulocity 0:099f76422485 55 ~CharValue();
Cumulocity 0:099f76422485 56
Cumulocity 0:099f76422485 57 uint8_t valueType() const;
Cumulocity 0:099f76422485 58 long integerValue() const;
Cumulocity 0:099f76422485 59 double floatValue() const;
Cumulocity 0:099f76422485 60 const char * characterValue() const;
Cumulocity 0:099f76422485 61
Cumulocity 0:099f76422485 62 size_t write(AbstractDataSink&) const;
Cumulocity 0:099f76422485 63 size_t length() const;
Cumulocity 0:099f76422485 64 Value* copy() const;
Cumulocity 0:099f76422485 65
Cumulocity 0:099f76422485 66 private:
Cumulocity 0:099f76422485 67 const char *_str;
Cumulocity 0:099f76422485 68 bool _alloc;
Cumulocity 0:099f76422485 69 };
Cumulocity 0:099f76422485 70
Cumulocity 0:099f76422485 71 #endif