#include <senml_bool_record.h>
A SenMLRecord that stores boolean data. This type of object can only be used for sensor data. If actuation is needed, use SenMLBoolActuator instead.
◆ SenMLBoolRecord() [1/5]
| SenMLBoolRecord::SenMLBoolRecord |
( |
const char * |
name | ) |
|
|
inline |
◆ SenMLBoolRecord() [2/5]
| SenMLBoolRecord::SenMLBoolRecord |
( |
const char * |
name, |
|
|
SenMLUnit |
unit |
|
) |
| |
|
inline |
◆ SenMLBoolRecord() [3/5]
| SenMLBoolRecord::SenMLBoolRecord |
( |
const char * |
name, |
|
|
SenMLUnit |
unit, |
|
|
bool |
value |
|
) |
| |
|
inline |
◆ SenMLBoolRecord() [4/5]
◆ SenMLBoolRecord() [5/5]
◆ ~SenMLBoolRecord()
| SenMLBoolRecord::~SenMLBoolRecord |
( |
| ) |
|
|
inline |
◆ fieldsToCbor()
| int SenMLBoolRecord::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 SenMLBoolRecord::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.
◆ get()
| bool SenMLBoolRecord::get |
( |
| ) |
|
|
inline |
Get the value assigned to this SenMLRecord. This function always returns the absolute value, also when the record is part of a pack that has a base value assigned.
- Returns
- : the value (including the base-value when applicable).
◆ set()
| bool SenMLBoolRecord::set |
( |
bool |
value, |
|
|
double |
time = (double)NAN |
|
) |
| |
|
inline |
Assign a value to the SenMLRecord. You can optionally assign the time at which the measurement was taken and if it should be interpreted as a sum or regular value.
- Parameters
-
| value | the value to store in the record |
| time | optional (default = NAN, meaning no time info). The time at which the measurement was taken. This should always be the absolute time value which will be converted relative to the base time when applicable (if the root is a SenMLPack with baseTime) . If you want to set the time manually relative to the basetime of the root-pack, then use setTime() instead. |
- Returns
- : true if the operation was succesful. See setTime() for more info when the operation can fail.
The documentation for this class was generated from the following files: