Utility class for a complete valid data definition of one StructType::Element and its dependencies. More...

#include <ddelement.h>

Public Types
using	Deserialized = dd::datamodel::StructType::DeserializedInfo
	Deserialized definiton for one element.

using	Serialized = dd::datamodel::StructType::SerializedInfo
	Serialized definiton for one element.

Public Member Functions
	DDElement ()=default
	Construct a new DDElement object.

	DDElement (DDElement &&)=default
	Construct a new DDElement object.

	DDElement (const DDElement &)=default
	Construct a new DDElement object.

DDElement &	operator= (DDElement &&)=default
	assignment move operator

DDElement &	operator= (const DDElement &)=default
	assignment copy operator

	~DDElement ()=default
	Destroy the DDElement object.

	DDElement (const std::string &name, const dd::DataType &data_type, const Deserialized &deserialized_info={}, const Serialized &serialized_info={}, const dd::ArraySize &array_size=1, const std::string &description={}, const std::string &comment={}, const dd::BaseUnit &base_unit={}, const std::string &minimum_value={}, const std::string &maximum_value={}, const std::string &default_value={}, const std::string &scale={}, const std::string &offset={})
	Construct a new DDElement object that uses a POD Type (dd::DataType) Use it like:

	DDElement (const std::string &name, const dd::DataType &data_type, const Deserialized &deserialized_info, const Serialized &serialized_info, const dd::ArraySize &array_size, const std::string &description, const std::string &comment, const DDUnit &unit, const std::string &minimum_value={}, const std::string &maximum_value={}, const std::string &default_value={}, const std::string &scale={}, const std::string &offset={})
	Construct a new DDElement object that uses a POD Type (dd::DataType) Use it like:

	DDElement (const std::string &name, const DDDataType &data_type, const Deserialized &deserialized_info={}, const Serialized &serialized_info={}, const dd::ArraySize &array_size=1, const std::string &description={}, const std::string &comment={}, const dd::BaseUnit &base_unit={}, const std::string &minimum_value={}, const std::string &maximum_value={}, const std::string &default_value={}, const std::string &scale={}, const std::string &offset={})
	Construct a new DDElement object that uses a POD Type (dd::DataType) Use it like:

	DDElement (const std::string &name, const DDDataType &data_type, const Deserialized &deserialized_info, const Serialized &serialized_info, const dd::ArraySize &array_size, const std::string &description, const std::string &comment, const DDUnit &unit, const std::string &minimum_value={}, const std::string &maximum_value={}, const std::string &default_value={}, const std::string &scale={}, const std::string &offset={})
	Construct a new DDElement object that uses a POD Type (dd::DataType) Use it like:

	DDElement (const std::string &name, const DDEnum &enum_type, const Deserialized &deserialized_info={}, const Serialized &serialized_info={}, const dd::ArraySize &array_size=1, const std::string &description={}, const std::string &comment={}, const dd::BaseUnit &base_unit={}, const std::string &value={}, const std::string &minimum_value={}, const std::string &maximum_value={}, const std::string &default_value={}, const std::string &scale={}, const std::string &offset={})
	Construct a new DDElement object that uses a Enum Type (dd::EnumType) Use it like:

	DDElement (const std::string &name, const DDEnum &enum_type, const Deserialized &deserialized_info, const Serialized &serialized_info, const dd::ArraySize &array_size, const std::string &description, const std::string &comment, const DDUnit &unit, const std::string &value={}, const std::string &minimum_value={}, const std::string &maximum_value={}, const std::string &default_value={}, const std::string &scale={}, const std::string &offset={})
	Construct a new DDElement object that uses a Enum Type (dd::EnumType) Use it like:

	DDElement (const std::string &name, const DDStructure &structure_type, const Deserialized &deserialized_info={}, const Serialized &serialized_info={}, const dd::ArraySize &array_size=1, const std::string &description={}, const std::string &comment={})
	Construct a new DDElement object that uses a Enum Type (dd::EnumType) Use it like:

const dd::StructType::Element &	getElement () const
	Get the Element object.

const dd::DataDefinition &	getDD () const
	retrieves a valid DataDefinition for the elements datatypes and units.

Private Attributes
dd::DataDefinition	_dd

dd::StructType::Element	_element

Detailed Description

Utility class for a complete valid data definition of one StructType::Element and its dependencies.

This class is for convenience to use it together with ddl::DDStructure .

See also: ddl::DDStructure.

Definition at line 36 of file ddelement.h.

Member Typedef Documentation

◆ Deserialized

using Deserialized = dd::datamodel::StructType::DeserializedInfo

Deserialized definiton for one element.

Definition at line 41 of file ddelement.h.

◆ Serialized

using Serialized = dd::datamodel::StructType::SerializedInfo

Serialized definiton for one element.

Definition at line 45 of file ddelement.h.

Constructor & Destructor Documentation

◆ DDElement() [1/7]

DDElement	(	const std::string &	name,
		const dd::DataType &	data_type,
		const Deserialized &	deserialized_info = {},
		const Serialized &	serialized_info = {},
		const dd::ArraySize &	array_size = 1,
		const std::string &	description = {},
		const std::string &	comment = {},
		const dd::BaseUnit &	base_unit = {},
		const std::string &	minimum_value = {},
		const std::string &	maximum_value = {},
		const std::string &	default_value = {},
		const std::string &	scale = {},
		const std::string &	offset = {} )

Construct a new DDElement object that uses a POD Type (dd::DataType) Use it like:

ddl::DDStructure dd_struct("StructType");

dd_struct.addElement(ddl::DDElement("element_name", ddl::DataType<uint32_t>()));

ddl::DDElement

Utility class for a complete valid data definition of one StructType::Element and its dependencies.

Definition ddelement.h:36

ddl::DDStructure

Utility class for a complete valid data definition of one StructType and its dependencies.

Definition ddstructure.h:57

ddl::DataType

Generator template to create DataType for the plain c-types.

Definition dd_predefined_datatypes.h:38

Parameters

name	Name of the element.
data_type	Data Type of the element. Use DataType template.
deserialized_info	deserialized information (will be set by default to the alignment of data_type).
serialized_info	serialized information of this element (will be set automatically to the next valid bytepos depending on previous elements).
array_size	array size of the element
description	description of the element
comment	comment of the element
base_unit	base_unit of the element to use
minimum_value	minimum value of the element
maximum_value	maximum value of the element
default_value	default value (mind! should fit to the data_type)
scale	scale of the element
offset	offset of the value

◆ DDElement() [2/7]

DDElement	(	const std::string &	name,
		const dd::DataType &	data_type,
		const Deserialized &	deserialized_info,
		const Serialized &	serialized_info,
		const dd::ArraySize &	array_size,
		const std::string &	description,
		const std::string &	comment,
		const DDUnit &	unit,
		const std::string &	minimum_value = {},
		const std::string &	maximum_value = {},
		const std::string &	default_value = {},
		const std::string &	scale = {},
		const std::string &	offset = {} )

Construct a new DDElement object that uses a POD Type (dd::DataType) Use it like:

ddl::DDUnit km("Kilometre", "1", "1", "0",
               { ddl::DDRefUnit(ddl::BaseUnit<ddl::unit::Metre>(),
                 3, ddl::UnitPrefix<ddl::unit_prefix::kilo>()) });
ddl::DDStructure dd_struct("StructType");
dd_struct.addElement(ddl::DDElement("element_name", ddl::DataType<uint32_t>(), {}, {}, 1, {},
{}, km));

Parameters

name	Name of the element.
data_type	Data Type of the element. Use DataType template.
deserialized_info	deserialized information (will be set by default to the alignment of data_type).
serialized_info	serialized information of this element (will be set automatically to the next valid bytepos depending on previous elements).
array_size	array size of the element
description	description of the element
comment	comment of the element
unit	unit of the element
minimum_value	minimum value of the element
maximum_value	maximum value of the element
default_value	default value (mind! should fit to the data_type)
scale	scale of the element
offset	offset of the value

◆ DDElement() [3/7]

DDElement	(	const std::string &	name,
		const DDDataType &	data_type,
		const Deserialized &	deserialized_info = {},
		const Serialized &	serialized_info = {},
		const dd::ArraySize &	array_size = 1,
		const std::string &	description = {},
		const std::string &	comment = {},
		const dd::BaseUnit &	base_unit = {},
		const std::string &	minimum_value = {},
		const std::string &	maximum_value = {},
		const std::string &	default_value = {},
		const std::string &	scale = {},
		const std::string &	offset = {} )

Construct a new DDElement object that uses a POD Type (dd::DataType) Use it like:

ddl::DDDataType custom_type("custom", 1);

ddl::DDStructure dd_struct("StructType");

dd_struct.addElement(ddl::DDElement("element_name", custom_type));

ddl::DDDataType

A DataType class holding the DD for a Datatype with dependencies.

Definition dddatatype.h:30

Parameters

name	Name of the element.
data_type	Data Type of the element. Use DataType template.
deserialized_info	deserialized information (will be set by default to the alignment of data_type).
serialized_info	serialized information of this element (will be set automatically to the next valid bytepos depending on previous elements).
array_size	array size of the element
description	description of the element
comment	comment of the element
base_unit	the base unit name of the element
minimum_value	minimum value of the element
maximum_value	maximum value of the element
default_value	default value (mind! should fit to the data_type)
scale	scale of the element
offset	offset of the value

◆ DDElement() [4/7]

DDElement	(	const std::string &	name,
		const DDDataType &	data_type,
		const Deserialized &	deserialized_info,
		const Serialized &	serialized_info,
		const dd::ArraySize &	array_size,
		const std::string &	description,
		const std::string &	comment,
		const DDUnit &	unit,
		const std::string &	minimum_value = {},
		const std::string &	maximum_value = {},
		const std::string &	default_value = {},
		const std::string &	scale = {},
		const std::string &	offset = {} )

Construct a new DDElement object that uses a POD Type (dd::DataType) Use it like:

ddl::DDDataType custom_type("custom", 1);
ddl::DDUnit km("Kilometre", "1", "1", "0",
               { ddl::DDRefUnit(ddl::BaseUnit<ddl::unit::Metre>(),
                 3, ddl::UnitPrefix<ddl::unit_prefix::kilo>()) });
ddl::DDStructure dd_struct("StructType");
dd_struct.addElement(ddl::DDElement("element_name", custom_type, {}, {}, 1, {}, {}, km));

Parameters

name	Name of the element.
data_type	Data Type of the element. Use DataType template.
deserialized_info	deserialized information (will be set by default to the alignment of data_type).
serialized_info	serialized information of this element (will be set automatically to the next valid bytepos depending on previous elements).
array_size	array size of the element
description	description of the element
comment	comment of the element
unit	the unit of the element
minimum_value	minimum value of the element
maximum_value	maximum value of the element
default_value	default value (mind! should fit to the data_type)
scale	scale of the element
offset	offset of the value

◆ DDElement() [5/7]

DDElement	(	const std::string &	name,
		const DDEnum &	enum_type,
		const Deserialized &	deserialized_info = {},
		const Serialized &	serialized_info = {},
		const dd::ArraySize &	array_size = 1,
		const std::string &	description = {},
		const std::string &	comment = {},
		const dd::BaseUnit &	base_unit = {},
		const std::string &	value = {},
		const std::string &	minimum_value = {},
		const std::string &	maximum_value = {},
		const std::string &	default_value = {},
		const std::string &	scale = {},
		const std::string &	offset = {} )

Construct a new DDElement object that uses a Enum Type (dd::EnumType) Use it like:

ddl::DDEnum dd_enum("EnumType",
                    ddl::DataType<uint32_t>(),
                    { {"val1", "1" }, { "val2", "2"} });
ddl::DDStructure dd_struct("StructType");
dd_struct.addElement(ddl::DDElement("element_enum", dd_enum));

Parameters

name	Name of the element.
enum_type	Enum Type of the element. Use DDEnum class.
deserialized_info	deserialized information (will be set by default to the alignment of data_type).
serialized_info	serialized information of this element (will be set automatically to the next valid bytepos depending on previous elements).
array_size	array size of the element
description	description of the element
comment	comment of the element
base_unit	the base unit of the element
value	constant value name of the element (mind! this constant should exists in given enum_type!)
minimum_value	minimum value of the element
maximum_value	maximum value of the element
default_value	default value (mind! should fit to the enum_types data_type)
scale	scale of the element
offset	offset of the value

◆ DDElement() [6/7]

DDElement	(	const std::string &	name,
		const DDEnum &	enum_type,
		const Deserialized &	deserialized_info,
		const Serialized &	serialized_info,
		const dd::ArraySize &	array_size,
		const std::string &	description,
		const std::string &	comment,
		const DDUnit &	unit,
		const std::string &	value = {},
		const std::string &	minimum_value = {},
		const std::string &	maximum_value = {},
		const std::string &	default_value = {},
		const std::string &	scale = {},
		const std::string &	offset = {} )

Construct a new DDElement object that uses a Enum Type (dd::EnumType) Use it like:

ddl::DDUnit km("Kilometre", "1", "1", "0",
               { ddl::DDRefUnit(ddl::BaseUnit<ddl::unit::Metre>(),
                 3, ddl::UnitPrefix<ddl::unit_prefix::kilo>()) });
ddl::DDEnum dd_enum("EnumType",
                    ddl::DataType<uint32_t>(),
                    { {"val1", "1" }, { "val2", "2"} });
ddl::DDStructure dd_struct("StructType");
dd_struct.addElement(ddl::DDElement("element_enum", dd_enum{}, {}, 1, {}, {}, km));

Parameters

name	Name of the element.
enum_type	Enum Type of the element. Use DDEnum class.
deserialized_info	deserialized information (will be set by default to the alignment of data_type).
serialized_info	serialized information of this element (will be set automatically to the next valid bytepos depending on previous elements).
array_size	array size of the element
description	description of the element
comment	comment of the element
unit	the unit name of the element
value	constant value name of the element (mind! this constant should exists in given enum_type!)
minimum_value	minimum value of the element
maximum_value	maximum value of the element
default_value	default value (mind! should fit to the enum_types data_type)
scale	scale of the element
offset	offset of the value

◆ DDElement() [7/7]

DDElement	(	const std::string &	name,
		const DDStructure &	structure_type,
		const Deserialized &	deserialized_info = {},
		const Serialized &	serialized_info = {},
		const dd::ArraySize &	array_size = 1,
		const std::string &	description = {},
		const std::string &	comment = {} )

Construct a new DDElement object that uses a Enum Type (dd::EnumType) Use it like:

ddl::DDEnum dd_enum("EnumType", ddl::DataType<uint32_t>(), { {"val1", "1" }, { "val2",

"2"} }); ddl::DDStructure dd_struct("StructType");

dd_struct.addElement(ddl::DDElement("element_enum", dd_enum));

Parameters

name	Name of the element.
structure_type	DDStructure Type of the element. Use DDStructure class.
deserialized_info	deserialized information (will be set by default to the alignment of data_type).
serialized_info	serialized information of this element (will be set automatically to the next valid bytepos depending on previous elements).
array_size	array size of the element
description	description of the element
comment	comment of the element

Member Function Documentation

◆ getDD()

const dd::DataDefinition & getDD ( ) const

retrieves a valid DataDefinition for the elements datatypes and units.

Returns: const dd::DataDefinition&

◆ getElement()

const dd::StructType::Element & getElement ( ) const

Get the Element object.

Returns: const dd::StructType::Element&

◆ operator=() [1/2]

DDElement & operator= ( const DDElement & )

default

assignment copy operator

Returns: DDElement& reference

References DDElement().

◆ operator=() [2/2]

DDElement & operator= ( DDElement && )

default

assignment move operator

Returns: DDElement& reference

References DDElement().

Member Data Documentation

◆ _dd

dd::DataDefinition _dd

private

Definition at line 374 of file ddelement.h.

◆ _element

dd::StructType::Element _element

private

Definition at line 376 of file ddelement.h.

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Deserialized

◆ Serialized

Constructor & Destructor Documentation

◆ DDElement() [1/7]

◆ DDElement() [2/7]

◆ DDElement() [3/7]

◆ DDElement() [4/7]

◆ DDElement() [5/7]

◆ DDElement() [6/7]

◆ DDElement() [7/7]

Member Function Documentation

◆ getDD()

◆ getElement()

◆ operator=() [1/2]

◆ operator=() [2/2]

Member Data Documentation

◆ _dd

◆ _element