#include <static_codec.h>

Inherits ddl::codec::StaticDecoder.

Public Types
typedef CodecElement< CodecElementAccess< StaticCodec > >	Element

typedef ChildElements< CodecElementAccess< StaticCodec > >	Elements

Public Types inherited from ddl::codec::StaticDecoder
typedef DecoderElement< DecoderElementAccess< const StaticDecoder > >	Element

typedef ChildElements< DecoderElementAccess< const StaticDecoder > >	Elements

Public Member Functions
	StaticCodec ()

	StaticCodec (const StaticCodec &)=delete

StaticCodec &	operator= (const StaticCodec &)=delete

	StaticCodec (StaticCodec &&)

StaticCodec &	operator= (StaticCodec &&)

Element	getElement (const CodecIndex &codec_index)

Element	getElement (std::string_view full_path)

Element	getChildElement (const CodecIndex &parent_codec_index, std::string_view relative_path)

Elements &	getElements ()

template<typename T>
void	setElementValue (const CodecIndex &codec_index, const T &value)

template<typename T>
void	setElementValue (const LeafCodecIndex &leaf_codec_index, const T &value)

void	setElementVariantValue (const CodecIndex &codec_index, const a_util::variant::Variant &value)

void	setElementStringValue (const CodecIndex &codec_index, const std::string &value)

void	setElementRawValue (const CodecIndex &codec_index, const void *value, size_t value_size)

void *	getElementAddress (const CodecIndex &codec_index)

void	resetValues (bool zero_values=false)

void *	getData () noexcept
	Get the current set data.

Element	getElement (const CodecIndex &codec_index) const

Element	getElement (std::string_view full_path) const

a_util::result::Result	getElement (size_t leaf_index, const ddl::StructElement *&legacy_struct_element) const

const void *	getElementAddress (const CodecIndex &index) const

const Elements &	getElements () const

const void *	getData () const noexcept
	Get the current set data.

Public Member Functions inherited from ddl::codec::StaticDecoder
	~StaticDecoder ()=default
	DTOR.

	StaticDecoder ()

	StaticDecoder (const StaticDecoder &)=delete

StaticDecoder &	operator= (const StaticDecoder &)=delete

	StaticDecoder (StaticDecoder &&)

StaticDecoder &	operator= (StaticDecoder &&)

virtual a_util::result::Result	isValid () const

Element	getElement (const CodecIndex &codec_index) const

Element	getElement (std::string_view full_path) const

Element	getChildElement (const CodecIndex &parent_codec_index, std::string_view relative_path) const

const Elements &	getElements () const

size_t	getElementChildCount (const CodecIndex &codec_index=CodecIndex()) const

std::string	getElementFullName (const CodecIndex &codec_index) const
	Retrieves the full name of the element within its main structure.

std::string	getElementName (const CodecIndex &codec_index) const
	Retrieves the name of the element within its structured element.

const std::string &	getElementBaseName (const CodecIndex &codec_index) const
	Retrieves the base name of the element within its structured element.

template<typename T>
T	getElementValue (const CodecIndex &codec_index) const

template<typename T>
T	getElementValue (const LeafCodecIndex &leaf_codec_index) const

a_util::variant::Variant	getElementVariantValue (const CodecIndex &codec_index) const

void	getElementVariantValue (const CodecIndex &codec_index, a_util::variant::Variant &value) const

std::string	getElementStringValue (const CodecIndex &codec_index) const

void	getElementRawValue (const CodecIndex &index, void *value, size_t value_size) const

const void *	getElementAddress (const CodecIndex &index) const

size_t	getStaticBufferSize () const
	Gets the static buffer size in bytes for the main structure.

size_t	getStaticBufferSize (DataRepresentation rep) const
	Gets the static buffer size in bytes for the main structure.

DataRepresentation	getRepresentation () const

CodecIndex	resolve (size_t leaf_index) const

CodecIndex	resolve (size_t leaf_index, std::string &element_full_name) const

size_t	getElementCount () const

a_util::result::Result	getElement (size_t leaf_index, const ddl::StructElement *&legacy_struct_element) const

void	resolve (CodecIndex &codec_index) const

const void *	getData () const noexcept
	Get the current set data.

size_t	getDataSize () const noexcept
	Get the current size (in bytes) of the data.

Friends
class	CodecFactory

Additional Inherited Members
Protected Member Functions inherited from ddl::codec::StaticDecoder
	StaticDecoder (std::shared_ptr< const StructAccess > codec_access, const void *data, size_t data_size, DataRepresentation representation)
	For internal use only.

Protected Attributes inherited from ddl::codec::StaticDecoder
std::shared_ptr< const StructAccess >	_codec_access
	For internal use only.

const void *	_data = nullptr
	For internal use only.

size_t	_data_size = 0
	For internal use only.

const ddl::codec::ElementAccessor *	_element_accessor
	For internal use only.

Detailed Description

Codec for static structures defined by a DataDefinition definition.

Member Typedef Documentation

◆ Element

typedef CodecElement<CodecElementAccess<StaticCodec> > ddl::codec::StaticCodec::Element

Static codec element.

◆ Elements

typedef ChildElements<CodecElementAccess<StaticCodec> > ddl::codec::StaticCodec::Elements

Iterator container to iterate all elements of the static decoder.

See also: forEachLeafElement, forEachElement; ddl::codec::ChildElements, StaticCodec::Element

Constructor & Destructor Documentation

◆ StaticCodec() [1/3]

ddl::codec::StaticCodec::StaticCodec ( )

Default constructor

◆ StaticCodec() [2/3]

ddl::codec::StaticCodec::StaticCodec ( const StaticCodec & )

delete

Noncopyable

◆ StaticCodec() [3/3]

ddl::codec::StaticCodec::StaticCodec ( StaticCodec && )

Move constructor.

Member Function Documentation

◆ getChildElement()

Element ddl::codec::StaticCodec::getChildElement	(	const CodecIndex &	parent_codec_index,
		std::string_view	relative_path )

Retrieves an element instance based on the child name of the element.

Parameters

[in]	parent_codec_index	The parent codec index.
[in]	relative_path	The child name of the element in point notation (i.e. `"child_element[4].element_value"`).

By using an empty string the deserialized decoding information within CodecIndex will retrieve the same codec index as it is before.

Returns: The child Codec Index of the StaticCodec.

Remarks: The element is only valid as long as the StaticCodec exists.

Exceptions

throws std::runtime_error if not found.

◆ getData() [1/2]

const void * ddl::codec::StaticDecoder::getData ( ) const

noexcept

Get the current set data.

Remarks: For performance issues this will not check any validity!

Returns: const void* The data pointer

◆ getData() [2/2]

void * ddl::codec::StaticCodec::getData ( )

noexcept

Get the current set data.

Remarks: For performance issues this will not check any validity!

Returns: void* The data pointer

◆ getElement() [1/5]

Element ddl::codec::StaticCodec::getElement ( const CodecIndex & codec_index )

Retrieves an element instance based on the codec index of that element.

Parameters

[in] codec_index The codec index.

Returns: The Codec Index of the CodecElement.

Remarks: The element is only valid as long as the static codec exists.

Exceptions

throws std::runtime_error if not found.

◆ getElement() [2/5]

Element ddl::codec::StaticDecoder::getElement ( const CodecIndex & codec_index ) const

Retrieves an element instance based on the codec index of that element.

Parameters

[in] codec_index The codec index.

Returns: The Codec Index of the DecoderElement.

Remarks: The element is only valid as long as the static decoder exists.

Exceptions

throws std::runtime_error if not found.

◆ getElement() [3/5]

a_util::result::Result ddl::codec::StaticDecoder::getElement	(	size_t	leaf_index,
		const ddl::StructElement *&	legacy_struct_element ) const

Returns the StructElement of the element with given leaf index.

Parameters

[in]	leaf_index	The leaf index of the element.
[out]	legacy_struct_element	the struct element legacy description.

Returns: The amount of static elements contained in the handled structure.

Remarks: This is for legacy access only!

◆ getElement() [4/5]

Element ddl::codec::StaticCodec::getElement ( std::string_view full_path )

Retrieves an element instance based on the full name of the element.

Parameters

[in] full_path The full name of the element in point notation (i.e. "element1.child_element[4].element_value").

By using an empty string the deserialized decoding information within CodecIndex will retrieve the buffers first address and whole buffersize. By refering an array without dedicated array index position the deserialized decoding information within CodecIndex will be set to the arrays first address and the whole array size. By refering an structured value (not a leaf value) the deserialized decoding information within CodecIndex will be set to the structs first address and the whole struct size.

Returns: The Codec Index of the CodecElement.

Remarks: The element is only valid as long as the static codec exists.

Exceptions

throws std::runtime_error if not found.

◆ getElement() [5/5]

Element ddl::codec::StaticDecoder::getElement ( std::string_view full_path ) const

Retrieves an element instance based on the full name of the element.

Parameters

[in] full_path The full name of the element in point notation (i.e. "element1.child_element[4].element_value").

By using an empty string the deserialized decoding information within CodecIndex will retrieve the buffers first address and whole buffersize. By refering an array without dedicated array index position the deserialized decoding information within CodecIndex will be set to the arrays first address and the whole array size. By refering an structured value (not a leaf value) the deserialized decoding information within CodecIndex will be set to the structs first address and the whole struct size.

Returns: The Codec Index of the DecoderElement.

Remarks: The element is only valid as long as the static decoder exists.

Exceptions

throws std::runtime_error if not found.

◆ getElementAddress() [1/2]

void * ddl::codec::StaticCodec::getElementAddress ( const CodecIndex & codec_index )

Parameters

[in] codec_index The index of the element.

Returns: A pointer to the element

Exceptions

throws std::runtime_error if not found.

◆ getElementAddress() [2/2]

const void * ddl::codec::StaticDecoder::getElementAddress ( const CodecIndex & index ) const

Parameters

[in] index The index of the element.

Returns: A pointer to the element or nullptr in case of an error.

◆ getElements() [1/2]

Elements & ddl::codec::StaticCodec::getElements ( )

Retrieves the elements of the static codec to get element information.

Returns: Elements The elements iterator container.

See also: forEachLeafElement, forEachElement, StaticCodec::Element, CodecIndex

◆ getElements() [2/2]

const Elements & ddl::codec::StaticDecoder::getElements ( ) const

Retrieves the elements of the static decoder to get element information.

Returns: Elements The elements iterator container.

See also: forEachLeafElement, forEachElement, StaticDecoder::Element, CodecIndex

◆ operator=() [1/2]

StaticCodec & ddl::codec::StaticCodec::operator= ( const StaticCodec & )

delete

Noncopyable

◆ operator=() [2/2]

StaticCodec & ddl::codec::StaticCodec::operator= ( StaticCodec && )

Move assignment operator.

◆ resetValues()

void ddl::codec::StaticCodec::resetValues ( bool zero_values = false )

Sets all elements to their default values, constant values defined in the data definition or zero if zero_values is set.

Parameters

[in] zero_values set the value to 0 if no constant or default value set in data definition.

◆ setElementRawValue()

void ddl::codec::StaticCodec::setElementRawValue	(	const CodecIndex &	codec_index,
		const void *	value,
		size_t	value_size )

Sets the current value of the given element by copying its data from the passed-in location.

Parameters

[in]	codec_index	The codec index of the element.
[in]	value	The location where the data should be copied from.
[in]	value_size	Size of the memory in `value` (if set to 0: unsafe usage of `value` without size check)

Exceptions

throws std::runtime_error if not found or value_size is lower then elements value memory to copy

◆ setElementStringValue()

void ddl::codec::StaticCodec::setElementStringValue	(	const CodecIndex &	codec_index,
		const std::string &	value )

Sets the current value of the given element from the given string. This will cast the given value to the elements data type!

Parameters

[in]	codec_index	The index of the element.
[in]	value	The value to set.

Exceptions

throws std::runtime_error if not found.

◆ setElementValue() [1/2]

template<typename T>

void ddl::codec::StaticCodec::setElementValue	(	const CodecIndex &	codec_index,
		const T &	value )

inline

Sets the current value of the given element from given value in type T. This will cast the given value to the elements data type!

Parameters

[in]	codec_index	The index of the element.
[in]	value	The value to set.

Template Parameters

T	Type of the value to set

Exceptions

throws std::runtime_error if not found.

◆ setElementValue() [2/2]

template<typename T>

void ddl::codec::StaticCodec::setElementValue	(	const LeafCodecIndex &	leaf_codec_index,
		const T &	value )

inline

Sets the current value of the given element from given value in type T. This will cast the given value to the elements data type!

Parameters

[in]	leaf_codec_index	The leaf codec index of the element.
[in]	value	The value to set.

Template Parameters

T	Type of the value to set

Exceptions

std::runtime_error if there is no valid conversion or the given leaf_codec_index is invalid

◆ setElementVariantValue()

void ddl::codec::StaticCodec::setElementVariantValue	(	const CodecIndex &	codec_index,
		const a_util::variant::Variant &	value )

Sets the current value of the given element from the given variant. If this element is a enum type the enum types element name can be used in value. Otherwise the string value is automatically converted to the elments data type, if possible.

Parameters

[in]	codec_index	The index of the element.
[in]	value	The value to set.

Exceptions

throws std::runtime_error if not found.

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

include/ddl/codec/static_codec.h

Public Types

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Element

◆ Elements

Constructor & Destructor Documentation

◆ StaticCodec() [1/3]

◆ StaticCodec() [2/3]

◆ StaticCodec() [3/3]

Member Function Documentation

◆ getChildElement()

◆ getData() [1/2]

◆ getData() [2/2]

◆ getElement() [1/5]

◆ getElement() [2/5]

◆ getElement() [3/5]

◆ getElement() [4/5]

◆ getElement() [5/5]

◆ getElementAddress() [1/2]

◆ getElementAddress() [2/2]

◆ getElements() [1/2]

◆ getElements() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ resetValues()

◆ setElementRawValue()

◆ setElementStringValue()

◆ setElementValue() [1/2]

◆ setElementValue() [2/2]

◆ setElementVariantValue()