ADTF: DDStructure

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

Inheritance diagram for DDStructure:

Public Types
typedef dd::datamodel::StructType::Elements::const_iterator	const_iterator
	iterator to iterate the elements of the struct

Public Member Functions
	DDStructure ()=delete
	Construct a new DDStructure object.

	DDStructure (DDStructure &&other)
	Construct a new DDStructure object. More...

	DDStructure (const DDStructure &other)
	Construct a new DDStructure object. More...

DDStructure &	operator= (DDStructure &&other)
	move assignment operator More...

DDStructure &	operator= (const DDStructure &other)
	copy assignment operator More...

	~DDStructure ()=default
	Destroy the DDStructure object.

	DDStructure (const std::string &name, const uint32_t struct_version=1, dd::OptionalSize alignment={}, const std::string &comment={}, const dd::Version &ddl_version={})
	Construct a new DDStructure object. More...

	DDStructure (const std::string &name, const std::string &xml_string, const dd::Version &ddl_xml_file_version_to_parse=dd::Version(0, 0))
	Construct a new DDStructure object. More...

DDStructure &	addElement (const std::string &element_name, const dd::DataType &data_type, size_t array_size=1)
	Adds one element to the struct using a (POD) DataType. More...

DDElementRef	createElement (const std::string &element_name, const dd::DataType &data_type, size_t array_size=1)
	Creates one element to the struct using a (POD) DataType. More...

DDStructure &	addElement (const std::string &element_name, const dd::DataType &data_type, size_t array_size, size_t alignment)
	Adds one element to the struct using a (POD) DataType. More...

DDElementRef	createElement (const std::string &element_name, const dd::DataType &data_type, size_t array_size, size_t alignment)
	Creates one element to the struct using a (POD) DataType. More...

DDStructure &	addElement (const std::string &element_name, const DDDataType &data_type, size_t array_size=1)
	Adds one element to the struct using a (POD) DataType. More...

DDElementRef	createElement (const std::string &element_name, const DDDataType &data_type, size_t array_size=1)
	Creates one element to the struct using a (POD) DataType. More...

DDStructure &	addElement (const std::string &element_name, const DDDataType &data_type, size_t array_size, size_t alignment)
	Adds one element to the struct using a (POD) DataType. More...

DDElementRef	createElement (const std::string &element_name, const DDDataType &data_type, size_t array_size, size_t alignment)
	Creates one element to the struct using a (POD) DataType. More...

template<typename PREDEF_DATA_TYPE >
DDStructure &	addElement (const std::string &element_name, size_t array_size=1, const std::string &special_type_name={})
	Adds one element to the struct using a (POD) DataType. More...

template<typename PREDEF_DATA_TYPE >
DDElementRef	createElement (const std::string &element_name, size_t array_size=1, const std::string &special_type_name={})
	Create one element to the struct using a (POD) DataType. More...

template<typename PREDEF_DATA_TYPE >
DDStructure &	addElement (const std::string &element_name, size_t array_size, size_t alignment, const std::string &special_type_name={})
	Adds one element to the struct using a (POD) DataType. More...

template<typename PREDEF_DATA_TYPE >
DDElementRef	createElement (const std::string &element_name, size_t array_size, size_t alignment, const std::string &special_type_name={})
	Creates one element to the struct using a (POD) DataType. More...

DDStructure &	addElement (const std::string &element_name, const DDEnum &enum_type, size_t array_size, const std::string &constant_value={})
	Adds one element to the struct using the convenience class DDEnum. More...

DDElementRef	createElement (const std::string &element_name, const DDEnum &enum_type, size_t array_size, const std::string &constant_value={})
	Creates one element to the struct using the convenience class DDEnum. More...

DDStructure &	addElement (const std::string &element_name, const DDEnum &enum_type, size_t array_size, size_t alignment, const std::string &constant_value={})
	Adds one element to the struct using the convenience class DDEnum. More...

DDElementRef	createElement (const std::string &element_name, const DDEnum &enum_type, size_t array_size, size_t alignment, const std::string &constant_value={})
	Creates one element to the struct using the convenience class DDEnum. More...

DDStructure &	addElement (const std::string &element_name, const DDEnum &enum_type, const std::string &constant_value={})
	Adds one element to the struct using the convenience class DDEnum. More...

DDElementRef	createElement (const std::string &element_name, const DDEnum &enum_type, const std::string &constant_value={})
	Creates one element to the struct using the convenience class DDEnum. More...

DDStructure &	addElement (const std::string &element_name, const DDStructure &struct_type, size_t array_size=1)
	Adds one element to the struct using the convenience class DDStructure. More...

DDElementRef	createElement (const std::string &element_name, const DDStructure &struct_type, size_t array_size=1)
	Creates one element to the struct using the convenience class DDStructure. More...

DDStructure &	addElement (const std::string &element_name, const DDStructure &struct_type, size_t array_size, size_t alignment)
	Adds one element to the struct using the convenience class DDStructure. More...

DDElementRef	createElement (const std::string &element_name, const DDStructure &struct_type, size_t array_size, size_t alignment)
	Creates one element to the struct using the convenience class DDStructure. More...

DDStructure &	addElement (const DDElement &element)
	Adds one element to the struct using the convenience class DDElement. More...

DDElementRef	createElement (const DDElement &element)
	Creates one element to the struct using the convenience class DDElement. More...

DDStructure &	addElements (const std::vector< DDElement > &elements)
	Adds a list of element to the struct using the convenience class DDElement. More...

const_iterator	cbegin () const
	returns the first elements iterator. More...

const_iterator	cend () const
	returns the end elements iterator. More...

const_iterator	begin () const
	returns the first elenents iterator for range based iterations. More...

const_iterator	end () const
	returns the end elements iterator. More...

const dd::DataDefinition &	getDD () const
	returns a valid DDL. More...

const dd::StructType &	getStructType () const
	Get the Struct Type object. More...

std::string	getStructDescription () const
	Gets the Struct Data Description as XML String. More...

std::string	getStructName () const
	Gets the Struct Name. More...

bool	isCompatible (const DDStructure &other) const
	binary compares the structs More...

bool	isEqual (const DDStructure &other) const
	equal in names and descriptions More...

size_t	getSize () const
	Retrieves the current evaluated deserialized size (in bytes) of the structure. More...

size_t	getAlignment () const
	Retrieves the current evaluated alignment of the structure. More...

void	setStructInfo (const std::string &comment)
	Set additional struct information like comment. More...

void	setElementInfo (const std::string &element_name, const std::string &description={}, const std::string &comment={}, 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={})
	Set additional element information to the given `element_name`. More...

void	setElementUnit (const std::string &element_name, const DDUnit &unit)
	Sets additional element unit information to the given `element_name`. More...

void	setElementUnit (const std::string &element_name, const dd::BaseUnit &base_unit)
	Sets additional element base unit information to the given `element_name`. More...

DDElementRef	getElement (const std::string &element_name)
	Gets a element reference to the element with name `element_name` owned by the DDStructure. More...

Private Member Functions
void	popLastElement ()

Private Attributes
dd::DataDefinition	_dd

std::shared_ptr< dd::StructType >	_struct_type

dd::OptionalSize	_initial_alignment = {}

Detailed Description

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

This class is for convenience to use create a StructType data defintion in code.
The class is to use as follows:

DDEnum e1("e1", DataType<int8_t>(), {{"val11", "1"}, {"val12", "2"}, {"val13", "3"}});
DDStructure a("A");
a.addElement<int32_t>("elem1");
a.addElement("elem2", DataType<uint16_t>());
a.addElement("elem3", e1, "val13");
 
DDStructure b("B");
b.addElement("nestedA1", a);
b.addElement("nestedA2", a);
 
//now you can do something with the created DD
b.getDD().isValid();
std::string dd_struct = b.getStructName();
std::string dd_description = b.getStructDescription();

See also: ddl::DDEnum, ddl::DataType

Definition at line 57 of file ddstructure.h.

Constructor & Destructor Documentation

◆ DDStructure() [1/4]

DDStructure ( DDStructure && other )

Construct a new DDStructure object.

Parameters

other the structure to move.

◆ DDStructure() [2/4]

DDStructure ( const DDStructure & other )

Construct a new DDStructure object.

Parameters

other the structure to copy.

◆ DDStructure() [3/4]

DDStructure	(	const std::string &	name,
		const uint32_t	struct_version = `1`,
		dd::OptionalSize	alignment = `{}`,
		const std::string &	comment = `{}`,
		const dd::Version &	ddl_version = `{}`
	)

explicit

Construct a new DDStructure object.

Parameters

name	typename of the new StructType
struct_version	version of the struct
alignment	optional alignment (if not set the alignment will be calculated automatically)
comment	optional comment
ddl_version	optional DDL language version of this struct (defines the size of the struct by alignment or not!)

◆ DDStructure() [4/4]

DDStructure	(	const std::string &	name,
		const std::string &	xml_string,
		const dd::Version &	ddl_xml_file_version_to_parse = `dd::Version(0, 0)`
	)

explicit

Construct a new DDStructure object.

Parameters

name	typename of the new StructType
xml_string	the xml string to read
ddl_xml_file_version_to_parse	optional DDL language version of the string.

Exceptions

ddl::dd::Error	if the xml string is not valid against the xsd definition! (depending on the DDL Version).
ddl::dd::Error	if the validation level of the created DataDefinition is not at least "good_enough"!
ddl::dd::Error	if the given `name` is not part of this description.

Member Function Documentation

◆ addElement() [1/12]

DDStructure& addElement ( const DDElement & element )

Adds one element to the struct using the convenience class DDElement.

Usage:

DDStructure a("A");

a.addElement(ddl::DDElement("elem1", 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::DataType

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

Definition: dd_predefined_datatypes.h:38

Parameters

element the DDElement

Returns: *this

Exceptions

ddl::dd::Error if the name of the given element already exists.

◆ addElement() [2/12]

DDStructure& addElement	(	const std::string &	element_name,
		const dd::DataType &	data_type,
		size_t	array_size,
		size_t	alignment
	)

Adds one element to the struct using a (POD) DataType.

Usage:

DDStructure a("A");

a.addElement("elem1", DataType<uint16_t>(), 1, 2);

Parameters

element_name	the name of the element
data_type	the data type
array_size	the arrysize of the element (by default 1)
alignment	alignment of the element

Remarks: all default DataTypes are always part of the DataDefinition if needed. See ddl::PredefinedDataTypes.

Returns: *this

Exceptions

ddl::dd::Error if the given element_name already exists.

◆ addElement() [3/12]

DDStructure& addElement	(	const std::string &	element_name,
		const dd::DataType &	data_type,
		size_t	array_size = `1`
	)

Adds one element to the struct using a (POD) DataType.

Usage:

DDStructure a("A");

a.addElement("elem1", DataType<uint16_t>());

Parameters

element_name	the name of the element
data_type	the data type
array_size	the arrysize of the element (by default 1)

Remarks: all default DataTypes are always part of the DataDefinition if needed. See ddl::PredefinedDataTypes.

Returns: *this

Exceptions

ddl::dd::Error if the given element_name already exists.

◆ addElement() [4/12]

DDStructure& addElement	(	const std::string &	element_name,
		const DDDataType &	data_type,
		size_t	array_size,
		size_t	alignment
	)

Adds one element to the struct using a (POD) DataType.

Usage:

DDDataType custom_type("custom", 1);
DDStructure a("A");
a.addElement("elem1", custom_type);

Parameters

element_name	the name of the element
data_type	the data type
array_size	the arrysize of the element (by default 1)
alignment	alignment of the element

Remarks: all default DataTypes are always part of the DataDefinition if needed. See ddl::PredefinedDataTypes.

Returns: *this

Exceptions

ddl::dd::Error if the given element_name already exists.

◆ addElement() [5/12]

DDStructure& addElement	(	const std::string &	element_name,
		const DDDataType &	data_type,
		size_t	array_size = `1`
	)

Adds one element to the struct using a (POD) DataType.

Usage:

DDDataType custom_type("custom", 1);
DDStructure a("A");
a.addElement("elem1", custom_type);

Parameters

element_name	the name of the element
data_type	the data type
array_size	the arrysize of the element (by default 1)

Remarks: all default DataTypes are always part of the DataDefinition if needed. See ddl::PredefinedDataTypes.

Returns: *this

Exceptions

ddl::dd::Error if the given element_name already exists.

◆ addElement() [6/12]

DDStructure& addElement	(	const std::string &	element_name,
		const DDEnum &	enum_type,
		const std::string &	constant_value = `{}`
	)

Adds one element to the struct using the convenience class DDEnum.

Usage:

DDEnum e1("e1", DataType<int8_t>(), { {"val11", "1"}, {"val12", "2"}, {"val13", "3"} });
DDStructure a("A");
a.addElement("elem1", e1);

Parameters

element_name	the name of the element
enum_type	the enum type
constant_value	the constant value name, defined within `enum_type`

Returns: *this

Exceptions

ddl::dd::Error if the given element_name already exists.

◆ addElement() [7/12]

DDStructure& addElement	(	const std::string &	element_name,
		const DDEnum &	enum_type,
		size_t	array_size,
		const std::string &	constant_value = `{}`
	)

Adds one element to the struct using the convenience class DDEnum.

Usage:

DDEnum e1("e1", DataType<int8_t>(), { {"val11", "1"}, {"val12", "2"}, {"val13", "3"} });
DDStructure a("A");
a.addElement("elem1", e1);

Parameters

element_name	the name of the element
enum_type	the enum type
array_size	the arrysize of the element (by default 1)
constant_value	the constant value name, defined within `enum_type`

Returns: *this

Exceptions

ddl::dd::Error if the given element_name already exists.

◆ addElement() [8/12]

DDStructure& addElement	(	const std::string &	element_name,
		const DDEnum &	enum_type,
		size_t	array_size,
		size_t	alignment,
		const std::string &	constant_value = `{}`
	)

Adds one element to the struct using the convenience class DDEnum.

Usage:

DDEnum e1("e1", DataType<int8_t>(), { {"val11", "1"}, {"val12", "2"}, {"val13", "3"} });
DDStructure a("A");
a.addElement("elem1", e1);

Parameters

element_name	the name of the element
enum_type	the enum type
array_size	the arrysize of the element (by default 1)
alignment	alignment of the element
constant_value	the constant value name, defined within `enum_type`

Returns: *this

Exceptions

ddl::dd::Error if the given element_name already exists.

◆ addElement() [9/12]

DDStructure& addElement	(	const std::string &	element_name,
		const DDStructure &	struct_type,
		size_t	array_size,
		size_t	alignment
	)

Adds one element to the struct using the convenience class DDStructure.

Usage:

DDEnum e1("e1", DataType<int8_t>(), { {"val11", "1"}, {"val12", "2"}, {"val13", "3"} });
DDStructure a("A");
a.addElement("elem1", e1);
a.addElement<uint16_t>("elem2");
DDStructure b("B");
b.addElement("nested1", a);
b.addElement("nested2", a);

Parameters

element_name	the name of the element
struct_type	the struct type
array_size	the arraysize of the element (by default 1)
alignment	the alignment for the element

Returns: *this

Exceptions

ddl::dd::Error if the given element_name already exists.

◆ addElement() [10/12]

DDStructure& addElement	(	const std::string &	element_name,
		const DDStructure &	struct_type,
		size_t	array_size = `1`
	)

Adds one element to the struct using the convenience class DDStructure.

Usage:

DDEnum e1("e1", DataType<int8_t>(), { {"val11", "1"}, {"val12", "2"}, {"val13", "3"} });
DDStructure a("A");
a.addElement("elem1", e1);
a.addElement<uint16_t>("elem2");
DDStructure b("B");
b.addElement("nested1", a);
b.addElement("nested2", a);

Parameters

element_name	the name of the element
struct_type	the struct type
array_size	the arrysize of the element (by default 1)

Returns: *this

Exceptions

ddl::dd::Error if the given element_name already exists.

◆ addElement() [11/12]

DDStructure& addElement	(	const std::string &	element_name,
		size_t	array_size,
		size_t	alignment,
		const std::string &	special_type_name = `{}`
	)

inline

Adds one element to the struct using a (POD) DataType.

Usage:

DDStructure a("A");
a.addElement<uint16_t>("elem1", 1, 2);
a.addElement<uint16_t>("elem2", 1, 4, "tUInt16");

Template Parameters

PREDEF_DATA_TYPE The POD type (float, int32_t ... etc. )

Parameters

element_name	the name of the element
array_size	the arrysize of the element (by default 1)
special_type_name	this typename is used instead of the typename predefined in DataType
alignment	alignment of the element

Remarks: all default DataTypes are always part of the DataDefinition if needed. See ddl::PredefinedDataTypes.

Returns: *this

Exceptions

ddl::dd::Error if the given element_name already exists.

Definition at line 395 of file ddstructure.h.

◆ addElement() [12/12]

DDStructure& addElement	(	const std::string &	element_name,
		size_t	array_size = `1`,
		const std::string &	special_type_name = `{}`
	)

inline

Adds one element to the struct using a (POD) DataType.

Usage:

DDStructure a("A");
a.addElement<uint16_t>("elem1");
a.addElement<uint16_t>("elem2", "tUInt16");

Template Parameters

PREDEF_DATA_TYPE The POD type (float, int32_t ... etc. )

Parameters

element_name	the name of the element
array_size	the arrysize of the element (by default 1)
special_type_name	this typename is used instead of the typename predefined in DataType

Remarks: all default DataTypes are always part of the DataDefinition if needed. See ddl::PredefinedDataTypes.

Returns: *this

Exceptions

ddl::dd::Error if the given element_name already exists.

Definition at line 326 of file ddstructure.h.

◆ addElements()

DDStructure& addElements ( const std::vector< DDElement > & elements )

Adds a list of element to the struct using the convenience class DDElement.

Usage:

DDEnum e1("e1", DataType<int8_t>(), { {"val11", "1"}, {"val12", "2"}, {"val13", "3"} }
DDStructure a("A");
a.addElements({ DDElement("elem1", DataType<uint64_t>()),
                DDElement("elem2", DataType<float>()) } );
a.addElements({ {"elem3", DataType<double>() },
                {"elem4", DataType<bool>() },
                {"elem5", e1 } });

Parameters

elements the list of DDElement

Returns: *this

Exceptions

ddl::dd::Error if a name of the given elements already exists.

◆ begin()

const_iterator begin ( ) const

inline

returns the first elenents iterator for range based iterations.

Returns: const_iterator

Definition at line 755 of file ddstructure.h.

◆ cbegin()

const_iterator cbegin ( ) const

inline

returns the first elements iterator.

Returns: const_iterator

Definition at line 737 of file ddstructure.h.

◆ cend()

const_iterator cend ( ) const

inline

returns the end elements iterator.

Returns: const_iterator

Definition at line 746 of file ddstructure.h.

◆ createElement() [1/12]

DDElementRef createElement ( const DDElement & element )

Creates one element to the struct using the convenience class DDElement.

Usage:

DDStructure a("A");

a.createElement(ddl::DDElement("elem1", ddl::DataType<uint32_t>()));

Parameters

element the DDElement

Returns: DDElementRef the reference to the created element

Exceptions

ddl::dd::Error if the name of the given element already exists.

◆ createElement() [2/12]

DDElementRef createElement	(	const std::string &	element_name,
		const dd::DataType &	data_type,
		size_t	array_size,
		size_t	alignment
	)

Creates one element to the struct using a (POD) DataType.

Usage:

DDStructure a("A");

a.createElement("elem1", DataType<uint16_t>(), 1, 2);

Parameters

element_name	the name of the element
data_type	the data type
array_size	the arrysize of the element (by default 1)
alignment	alignment of the element

Remarks: all default DataTypes are always part of the DataDefinition if needed. See ddl::PredefinedDataTypes.

Returns: DDElementRef the reference to the created element

Exceptions

ddl::dd::Error if the given element_name already exists.

◆ createElement() [3/12]

DDElementRef createElement	(	const std::string &	element_name,
		const dd::DataType &	data_type,
		size_t	array_size = `1`
	)

Creates one element to the struct using a (POD) DataType.

Usage:

DDStructure a("A");

a.createElement("elem1", DataType<uint16_t>());

Parameters

element_name	the name of the element
data_type	the data type
array_size	the arrysize of the element (by default 1)

Remarks: all default DataTypes are always part of the DataDefinition if needed. See ddl::PredefinedDataTypes.

Returns: DDElement the reference to the created element

Exceptions

ddl::dd::Error if the given element_name already exists.

◆ createElement() [4/12]

DDElementRef createElement	(	const std::string &	element_name,
		const DDDataType &	data_type,
		size_t	array_size,
		size_t	alignment
	)

Creates one element to the struct using a (POD) DataType.

Usage:

DDDataType custom_type("custom", 1);
DDStructure a("A");
a.createElement("elem1", custom_type);

Parameters

element_name	the name of the element
data_type	the data type
array_size	the arraysize of the element (by default 1)
alignment	alignment of the element

Remarks: all default DataTypes are always part of the DataDefinition if needed. See ddl::PredefinedDataTypes.

Returns: DDElementRef the reference to the created element

Exceptions

ddl::dd::Error if the given element_name already exists.

◆ createElement() [5/12]

DDElementRef createElement	(	const std::string &	element_name,
		const DDDataType &	data_type,
		size_t	array_size = `1`
	)

Creates one element to the struct using a (POD) DataType.

Usage:

DDDataType custom_type("custom", 1);
DDStructure a("A");
a.createElement("elem1", custom_type);

Parameters

element_name	the name of the element
data_type	the data type
array_size	the arrysize of the element (by default 1)

Remarks: all default DataTypes are always part of the DataDefinition if needed. See ddl::PredefinedDataTypes.

Returns: DDElementRef the reference to the created element

Exceptions

ddl::dd::Error if the given element_name already exists.

◆ createElement() [6/12]

DDElementRef createElement	(	const std::string &	element_name,
		const DDEnum &	enum_type,
		const std::string &	constant_value = `{}`
	)

Creates one element to the struct using the convenience class DDEnum.

Usage:

DDEnum e1("e1", DataType<int8_t>(), { {"val11", "1"}, {"val12", "2"}, {"val13", "3"} });
DDStructure a("A");
a.createElement("elem1", e1);

Parameters

element_name	the name of the element
enum_type	the enum type
constant_value	the constant value name, defined within `enum_type`

Returns: DDElement the reference to the created element

Exceptions

ddl::dd::Error if the given element_name already exists.

◆ createElement() [7/12]

DDElementRef createElement	(	const std::string &	element_name,
		const DDEnum &	enum_type,
		size_t	array_size,
		const std::string &	constant_value = `{}`
	)

Creates one element to the struct using the convenience class DDEnum.

Usage:

DDEnum e1("e1", DataType<int8_t>(), { {"val11", "1"}, {"val12", "2"}, {"val13", "3"} });
DDStructure a("A");
a.createElement("elem1", e1);

Parameters

element_name	the name of the element
enum_type	the enum type
array_size	the arrysize of the element (by default 1)
constant_value	the constant value name, defined within `enum_type`

Returns: DDElementRef the reference to the created element

Exceptions

ddl::dd::Error if the given element_name already exists.

◆ createElement() [8/12]

DDElementRef createElement	(	const std::string &	element_name,
		const DDEnum &	enum_type,
		size_t	array_size,
		size_t	alignment,
		const std::string &	constant_value = `{}`
	)

Creates one element to the struct using the convenience class DDEnum.

Usage:

DDEnum e1("e1", DataType<int8_t>(), { {"val11", "1"}, {"val12", "2"}, {"val13", "3"} });
DDStructure a("A");
a.createElement("elem1", e1);

Parameters

element_name	the name of the element
enum_type	the enum type
array_size	the arrysize of the element (by default 1)
alignment	alignment of the element
constant_value	the constant value name, defined within `enum_type`

Returns: DDElementRef the reference to the created element

Exceptions

ddl::dd::Error if the given element_name already exists.

◆ createElement() [9/12]

DDElementRef createElement	(	const std::string &	element_name,
		const DDStructure &	struct_type,
		size_t	array_size,
		size_t	alignment
	)

Creates one element to the struct using the convenience class DDStructure.

Usage:

DDEnum e1("e1", DataType<int8_t>(), { {"val11", "1"}, {"val12", "2"}, {"val13", "3"} });
DDStructure a("A");
a.createElement("elem1", e1);
a.createElement<uint16_t>("elem2");
DDStructure b("B");
b.createElement("nested1", a);
b.createElement("nested2", a);

Parameters

element_name	the name of the element
struct_type	the struct type
array_size	the arraysize of the element (by default 1)
alignment	the alignment for the element

Returns: DDElementRef the reference to the created element

Exceptions

ddl::dd::Error if the given element_name already exists.

◆ createElement() [10/12]

DDElementRef createElement	(	const std::string &	element_name,
		const DDStructure &	struct_type,
		size_t	array_size = `1`
	)

Creates one element to the struct using the convenience class DDStructure.

Usage:

DDEnum e1("e1", DataType<int8_t>(), { {"val11", "1"}, {"val12", "2"}, {"val13", "3"} });
DDStructure a("A");
a.createElement("elem1", e1);
a.createElement<uint16_t>("elem2");
DDStructure b("B");
b.createElement("nested1", a);
b.createElement("nested2", a);

Parameters

element_name	the name of the element
struct_type	the struct type
array_size	the arrysize of the element (by default 1)

Returns: DDElementRef the reference to the created element

Exceptions

ddl::dd::Error if the given element_name already exists.

◆ createElement() [11/12]

DDElementRef createElement	(	const std::string &	element_name,
		size_t	array_size,
		size_t	alignment,
		const std::string &	special_type_name = `{}`
	)

inline

Creates one element to the struct using a (POD) DataType.

Usage:

DDStructure a("A");
a.createElement<uint16_t>("elem1", 1, 2);
a.createElement<uint16_t>("elem2", 1, 4, "tUInt16");

Template Parameters

PREDEF_DATA_TYPE The POD type (float, int32_t ... etc. )

Parameters

element_name	the name of the element
array_size	the arrysize of the element (by default 1)
special_type_name	this typename is used instead of the typename predefined in DataType
alignment	alignment of the element

Remarks: all default DataTypes are always part of the DataDefinition if needed. See ddl::PredefinedDataTypes.

Returns: DDElementRef the reference to the created element

Exceptions

ddl::dd::Error if the given element_name already exists.

Definition at line 432 of file ddstructure.h.

◆ createElement() [12/12]

DDElementRef createElement	(	const std::string &	element_name,
		size_t	array_size = `1`,
		const std::string &	special_type_name = `{}`
	)

inline

Create one element to the struct using a (POD) DataType.

Usage:

DDStructure a("A");
a.createElement<uint16_t>("elem1");
a.createElement<uint16_t>("elem2", "tUInt16");

Template Parameters

PREDEF_DATA_TYPE The POD type (float, int32_t ... etc. )

Parameters

element_name	the name of the element
array_size	the arrysize of the element (by default 1)
special_type_name	this typename is used instead of the typename predefined in DataType

Remarks: all default DataTypes are always part of the DataDefinition if needed. See ddl::PredefinedDataTypes.

Returns: DDElementRef the reference to the created element

Exceptions

ddl::dd::Error if the given element_name already exists.

Definition at line 360 of file ddstructure.h.

◆ end()

const_iterator end ( ) const

inline

returns the end elements iterator.

Returns: const_iterator

Definition at line 764 of file ddstructure.h.

◆ getAlignment()

size_t getAlignment ( ) const

Retrieves the current evaluated alignment of the structure.

Returns: the alignment

Referenced by DDStructureGenerator< T, align_with_padding >::getAlignment().

◆ getDD()

const dd::DataDefinition& getDD ( ) const

returns a valid DDL.

Returns: const dd::DataDefinition&

Referenced by DDStructureGenerator< T, align_with_padding >::getDD().

◆ getElement()

DDElementRef getElement ( const std::string & element_name )

Gets a element reference to the element with name element_name owned by the DDStructure.

Parameters

element_name the elements name

Returns: the element reference

Exceptions

dd::Error if element was not found

Referenced by DDStructureGenerator< T, align_with_padding >::getElement().

◆ getSize()

size_t getSize ( ) const

Retrieves the current evaluated deserialized size (in bytes) of the structure.

Returns: the size (in bytes)

Referenced by DDStructureGenerator< T, align_with_padding >::getSize().

◆ getStructDescription()

std::string getStructDescription ( ) const

Gets the Struct Data Description as XML String.

Returns: std::string

Referenced by DDStructureGenerator< T, align_with_padding >::getStructDescription().

◆ getStructName()

std::string getStructName ( ) const

Gets the Struct Name.

Returns: std::string

Referenced by DDStructureGenerator< T, align_with_padding >::getStructName().

◆ getStructType()

const dd::StructType& getStructType ( ) const

Get the Struct Type object.

Returns: const dd::StructType&

Referenced by DDStructureGenerator< T, align_with_padding >::getStructType().

◆ isCompatible()

bool isCompatible ( const DDStructure & other ) const

binary compares the structs

Parameters

other the other struct to binary compare to

Returns: true The structs are binary comaptible in memory; false the struct are not binary compatible

◆ isEqual()

bool isEqual ( const DDStructure & other ) const

equal in names and descriptions

Parameters

other the other struct

Returns: true the structs are identically; false the structs are different

◆ operator=() [1/2]

DDStructure& operator= ( const DDStructure & other )

copy assignment operator

Parameters

other the structure to copy.

Returns: DDStructure&

◆ operator=() [2/2]

DDStructure& operator= ( DDStructure && other )

move assignment operator

Parameters

other the structure to move.

Returns: DDStructure&

◆ setElementInfo()

void setElementInfo	(	const std::string &	element_name,
		const std::string &	description = `{}`,
		const std::string &	comment = `{}`,
		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 = `{}`
	)

Set additional element information to the given element_name.

Remarks: The element with the name element_name must have been added before! The info will only be set if the string of the parameter is not empty!

Parameters

element_name	The element name to set the additional info to
description	The description
comment	The comment
value	The value
minimum_value	The minimum value
maximum_value	The maximum value
default_value	The default value
scale	The scale
offset	The offset

Exceptions

dd::Error if element with element_name does not exist.

◆ setElementUnit() [1/2]

void setElementUnit	(	const std::string &	element_name,
		const dd::BaseUnit &	base_unit
	)

Sets additional element base unit information to the given element_name.

Any other unit information will be overwritten.

Remarks: The element with the name element_name must have been added before!

Parameters

element_name	The element name
base_unit	The baseunit to set

Exceptions

dd::Error if element with element_name does not exist.

◆ setElementUnit() [2/2]

void setElementUnit	(	const std::string &	element_name,
		const DDUnit &	unit
	)

Sets additional element unit information to the given element_name.

Any other unit information will be overwritten.
Remarks
The element with the name element_name must have been added before!

Parameters

element_name The element name

unit The unit to set

Exceptions

dd::Error if element with element_name does not exist.

Referenced by DDStructureGenerator< T, align_with_padding >::setElementUnit().

◆ setStructInfo()

void setStructInfo ( const std::string & comment )

Set additional struct information like comment.

This is important to create additional info in type reflection for DDStructureGenerator.

Parameters

comment The comment of the struct type.

Referenced by DDStructureGenerator< T, align_with_padding >::setStructInfo().

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DDStructure() [1/4]

◆ DDStructure() [2/4]

◆ DDStructure() [3/4]

◆ DDStructure() [4/4]

Member Function Documentation

◆ addElement() [1/12]

◆ addElement() [2/12]

◆ addElement() [3/12]

◆ addElement() [4/12]

◆ addElement() [5/12]

◆ addElement() [6/12]

◆ addElement() [7/12]

◆ addElement() [8/12]

◆ addElement() [9/12]

◆ addElement() [10/12]

◆ addElement() [11/12]

◆ addElement() [12/12]

◆ addElements()

◆ begin()

◆ cbegin()

◆ cend()

◆ createElement() [1/12]

◆ createElement() [2/12]

◆ createElement() [3/12]

◆ createElement() [4/12]

◆ createElement() [5/12]

◆ createElement() [6/12]

◆ createElement() [7/12]

◆ createElement() [8/12]

◆ createElement() [9/12]

◆ createElement() [10/12]

◆ createElement() [11/12]

◆ createElement() [12/12]

◆ end()

◆ getAlignment()

◆ getDD()

◆ getElement()

◆ getSize()

◆ getStructDescription()

◆ getStructName()

◆ getStructType()

◆ isCompatible()

◆ isEqual()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setElementInfo()

◆ setElementUnit() [1/2]

◆ setElementUnit() [2/2]

◆ setStructInfo()