KPN Things Device SDK
SenMLStringRecord Class Reference

#include <senml_string_record.h>

Inheritance diagram for SenMLStringRecord:
SenMLRecordTemplate< const char * > SenMLRecord SenMLBase SenMLStringActuator

Public Member Functions

 SenMLStringRecord (const char *name)
 
 SenMLStringRecord (const char *name, SenMLUnit unit)
 
 SenMLStringRecord (const char *name, SenMLUnit unit, const char *value)
 
 SenMLStringRecord (ThingsMLMeasurementIndex index)
 
 SenMLStringRecord (ThingsMLMeasurementIndex index, const char *value)
 
virtual int fieldsToJson ()
 
virtual int fieldsToCbor ()
 
- Public Member Functions inherited from SenMLRecordTemplate< const char * >
 SenMLRecordTemplate (const char *name)
 
 SenMLRecordTemplate (const char *name, SenMLUnit unit)
 
 SenMLRecordTemplate (const char *name, SenMLUnit unit, const char * value)
 
 SenMLRecordTemplate (ThingsMLMeasurementIndex index)
 
 SenMLRecordTemplate (ThingsMLMeasurementIndex index, const char * value)
 
const char * get ()
 
bool asSum ()
 
bool set (const char * value, double time=(double) NAN, bool asSum=false)
 
- Public Member Functions inherited from SenMLRecord
 SenMLRecord ()
 
 SenMLRecord (const char *name)
 
 SenMLRecord (ThingsMLMeasurementIndex index)
 
 SenMLRecord (const char *name, SenMLUnit unit)
 
double getTime ()
 
bool setTime (double value, bool absolute=true)
 
void setTimeDirect (double value)
 
const char * getName ()
 
ThingsMLMeasurementIndex getIndex ()
 
void setName (const char *name)
 
double getUpdateTime ()
 
bool setUpdateTime (double value, bool absolute=true)
 
SenMLUnit getUnit ()
 
void setUnit (SenMLUnit value)
 
virtual int fieldsToJson ()
 
virtual int fieldsToCbor ()
 
- Public Member Functions inherited from SenMLBase
 SenMLBase ()
 
 ~SenMLBase ()
 
SenMLBasegetNext ()
 
SenMLBasegetRoot ()
 
virtual void adjustToBaseTime (double prev, double time)
 
virtual int fieldsToJson ()=0
 
virtual int fieldsToCbor ()=0
 

Additional Inherited Members

- Protected Member Functions inherited from SenMLRecord
virtual int contentToJson ()
 
virtual int contentToCbor ()
 
virtual void adjustToBaseTime (double prev, double time)
 
virtual void actuate (const void *value, int dataLength, SenMLDataType dataType)
 
int getFieldLength ()
 
- Protected Member Functions inherited from SenMLBase
virtual int contentToJson ()=0
 
void setNext (SenMLBase *value)
 
void setPrev (SenMLBase *value)
 
SenMLBasegetPrev ()
 
virtual bool isPack ()
 
virtual int contentToCbor ()=0
 
virtual int getArrayLength ()
 
virtual int getFieldLength ()=0
 

Detailed Description

A SenMLRecord that stores text data. This type of object can only be used for sensor data. If actuation is needed, use SenMLStringActuator instead.

Constructor & Destructor Documentation

◆ SenMLStringRecord() [1/5]

SenMLStringRecord::SenMLStringRecord ( const char *  name)
inline

◆ SenMLStringRecord() [2/5]

SenMLStringRecord::SenMLStringRecord ( const char *  name,
SenMLUnit  unit 
)
inline

◆ SenMLStringRecord() [3/5]

SenMLStringRecord::SenMLStringRecord ( const char *  name,
SenMLUnit  unit,
const char *  value 
)
inline

◆ SenMLStringRecord() [4/5]

SenMLStringRecord::SenMLStringRecord ( ThingsMLMeasurementIndex  index)
inline

◆ SenMLStringRecord() [5/5]

SenMLStringRecord::SenMLStringRecord ( ThingsMLMeasurementIndex  index,
const char *  value 
)
inline

Member Function Documentation

◆ fieldsToCbor()

int SenMLStringRecord::fieldsToCbor ( )
virtual

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.

Reimplemented from SenMLRecord.

◆ fieldsToJson()

int SenMLStringRecord::fieldsToJson ( )
virtual

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
: The number of bytes that were written.

Reimplemented from SenMLRecord.


The documentation for this class was generated from the following files: