ScalarData

General description

Data packet of the ScalarData type contains a generic unique value. The value can be modified by a value of the same type.

Payload details

name	type	description
data	any type	scalar value

API

template<typenameTYPE>
class Data : public Base::Data

Public Functions

inline ScalarData(TYPE data = 0)

inline void Initialize(const Parameters<TYPE> &parameters)

inline void ClearData() override

inline TYPE const &data() const

inline void set_data(const TYPE &data)

inline void set_data(const Data<TYPE> &source)

inline void SerializeBinary(std::ostream &stream, Serialization::Format format = Serialization::Format::FULL) const override

inline void SerializeYAML(YAML::Node &node, Serialization::Format format = Serialization::Format::FULL) const override

inline void YAMLDescription(YAML::Node &node, Serialization::Format format = Serialization::Format::FULL) const override

Friends

inline friend bool operator==(Data<TYPE> &a, Data<TYPE> &b)

inline friend bool operator!=(Data<TYPE> &a, Data<TYPE> &b)

Parameters

name	type	description	validation
default_value	any type

template<typename TYPE>
struct Parameters : public Base::Parameters

Public Functions

inline Parameters(TYPE value)

Public Members

TYPE default_value

Capabilities

class Capabilities : public Base::Capabilities

Binary Serialization

For serialization formats FULL and COMPACT, the data variable is sent as a string.

YAML Serialization

For serialization formats FULL and COMPACT,

the following YAML is emitted:

scalar_data [data]