BAOS SDK v2  1.0.1
An SDK providing access to IP-BAOS devices through BAOS binary protocol version 2.x
DatapointStatus Struct Reference

Internal state for each datapoint in the object server. More...

#include <baos/protocol/Defines.h>

Public Member Functions

 DatapointStatus (std::uint8_t &&value)
 Construct from byte value.
 
DatapointStatusoperator= (std::uint8_t &value)
 Assign value from byte.
 
std::string toString () const
 Represent the flags in a human readable form. More...
 

Public Attributes

std::uint8_t transmitStatus: 2
 See BAOS binary protocol spec GetDatapointValue.Res state byte for details. More...
 
std::uint8_t readRequest: 1
 0 Write request should be sent, 1 Read request should be sent
 
std::uint8_t updated: 1
 
std::uint8_t valid: 1
 0 Object value is invalid or 1 the device has seen at least one value for the group object.
 
std::uint8_t reserved_1: 1
 Reserved bit 1.
 
std::uint8_t reserved_2: 1
 Reserved bit 2.
 
std::uint8_t reserved_3: 1
 Reserved bit 3.
 

Detailed Description

Internal state for each datapoint in the object server.

Member Function Documentation

◆ toString()

std::string toString ( ) const
inline

Represent the flags in a human readable form.

The output string has the form e.g. "VUR Idle_OK" every flag not set is represented by an underscore. The first character is V for valid, the second is U for updated, the third is R for read request and W for write request. The transmission status is represented by

See also
transmissionStatusToString
Returns
std::string

Member Data Documentation

◆ transmitStatus

std::uint8_t transmitStatus

See BAOS binary protocol spec GetDatapointValue.Res state byte for details.

The tranmission status.

See also
TransmissionStatus

◆ updated

std::uint8_t updated

Value was updated from bus, cleared after it is read be client or indication is send to client


The documentation for this struct was generated from the following file: