Diff: senml_string_record.h

Revision:

0:a9259748d982

diff -r 000000000000 -r a9259748d982 senml_string_record.h
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/senml_string_record.h	Sat May 19 17:35:20 2018 +0000
@@ -0,0 +1,63 @@
+/*  _  __  ____    _   _ 
+ * | |/ / |  _ \  | \ | |
+ * | ' /  | |_) | |  \| |
+ * | . \  |  __/  | |\  |
+ * |_|\_\ |_|     |_| \_|
+ * 
+ * (c) 2018 KPN
+ * License: MIT License.
+ * Author: Jan Bogaerts
+ * 
+ * support for string sensors
+ */
+
+#ifndef SENMLSTRINGRECORD
+#define SENMLSTRINGRECORD
+
+#include <senml_record_t.h>
+
+/**
+ * A SenMLRecord that stores text data.
+ * This type of object can only be used for sensor data. If actuation is needed, use SenMLStringActuator
+ * instead.
+ */ 
+class SenMLStringRecord: public SenMLRecordTemplate<String>
+{
+public:
+    SenMLStringRecord(const char* name):  SenMLRecordTemplate(name){};
+    SenMLStringRecord(const char* name, SenMLUnit unit):  SenMLRecordTemplate(name, unit){};
+    SenMLStringRecord(const char* name, SenMLUnit unit, const char* value):  SenMLRecordTemplate(name, unit, value){};
+    //~SenMLStringRecord(){};
+
+    /**
+     * renders all the fields to json, without the starting and ending brackets.
+     * Inheriters can extend this function if they want to add extra fields to the json output
+     * note: this is public so that custom implementations for the record object can use other objects 
+     * internally and render to json using this function (ex: coordinatesRecord using 3 floatRecrods for lat, lon & alt.
+     * @returns: None
+    */
+    virtual void fieldsToJson();
+
+    /**
+     * renders all the fields to cbor format. renders all the fields of the object without the length info 
+     * at the beginning
+     * note: this is public so that custom implementations for the record object can use other objects 
+     * internally and render to json using this function (ex: coordinatesRecord using 3 floatRecrods for 
+     * lat, lon & alt.
+     * @returns: The number of bytes that were written.
+    */
+    virtual int fieldsToCbor();
+protected:
+
+    
+private:
+};
+
+#endif // SENMLSTRINGRECORD
+
+
+
+
+
+
+