Codec

Decoder for dynamic structures defined by a DataDefinition definition. More...

Inheritance diagram for Codec:

Public Types
typedef CodecElement< CodecElementAccess< Codec > >	Element
	Codec element.
typedef ChildElements< CodecElementAccess< Codec > >	Elements
	Iterator container to iterate all elements of the codec. More...
Public Types inherited from Decoder
typedef DecoderElement< DecoderElementAccess< const Decoder > >	Element
	Decoder element.
typedef ChildElements< DecoderElementAccess< const Decoder > >	Elements
	Iterator container to iterate all elements of the decoder and get values. More...
Public Types inherited from StaticDecoder
typedef DecoderElement< DecoderElementAccess< const StaticDecoder > >	Element
	Static decoder element.
typedef ChildElements< DecoderElementAccess< const StaticDecoder > >	Elements
	Iterator container to iterate all elements of the static decoder. More...

Public Member Functions
	Codec ()
	Default constructor.
	Codec (Codec &&)
	Move constructor.
Codec &	operator= (Codec &&)
	Move assignment operator.
	Codec (const Codec &)=delete
	No copy constructor.
Codec &	operator= (const Codec &)=delete
	No copy assignment operator.
Element	getElement (const CodecIndex &codec_index)
	Retrieves an element instance based on the codec index of that element. More...
Element	getElement (const std::string &full_element_name)
	Retrieves an element instance based on the full name of the element. More...
Elements &	getElements ()
	Retrieves the elements of the codec to get element information. More...
template<typename T >
void	setElementValue (const CodecIndex &codec_index, const T &value)
	Sets the current value of the given element from given value in type T. More...
template<typename T >
void	setElementValue (const LeafCodecIndex &leaf_codec_index, const T &value)
	Sets the current value of the given element from given value in type T. More...
void	setElementVariantValue (const CodecIndex &codec_index, const a_util::variant::Variant &value)
	Sets the current value of the given element from the given variant. More...
void	setElementStringValue (const CodecIndex &codec_index, const std::string &value)
	Sets the current value of the given element from the given string. More...
void	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. More...
void *	getElementAddress (const CodecIndex &codec_index)
void	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. More...
void *	getData () noexcept
	Get the current set data. More...
Element	getElement (const CodecIndex &codec_index) const
	Retrieves an element instance based on the codec index of that element. More...
Element	getElement (const std::string &full_element_name) const
	Retrieves an element instance based on the full name of the element. More...
const Elements &	getElements () const
	Retrieves the elements of the decoder to get element information and get values. More...
Public Member Functions inherited from Decoder
	Decoder ()
	Default constructor.
	Decoder (Decoder &&)
	Move constructor.
Decoder &	operator= (Decoder &&)
	Move assignment operator.
	Decoder (const Decoder &)=delete
	No copy constructor.
Decoder &	operator= (const Decoder &)=delete
	No copy assignment operator.
a_util::result::Result	isValid () const override
Element	getElement (const CodecIndex &codec_index) const
	Retrieves an element instance based on the codec index of that element. More...
Element	getElement (const std::string &full_element_name) const
	Retrieves an element instance based on the full name of the element. More...
const Elements &	getElements () const
	Retrieves the elements of the decoder to get element information and get values. More...
size_t	getBufferSize () const
	Gets the buffer size in bytes for the main structure. More...
size_t	getBufferSize (DataRepresentation representation) const
	Gets the buffer size in bytes for the main structure. More...
Codec	makeCodecFor (void *data, size_t data_size, DataRepresentation representation) const
	Create a new codec with the current dynamic structure layout for a new data buffer. More...
Public Member Functions inherited from StaticDecoder
	~StaticDecoder ()=default
	DTOR.
	StaticDecoder ()
	Default constructor.
	StaticDecoder (const StaticDecoder &)=delete
	Noncopyable.
StaticDecoder &	operator= (const StaticDecoder &)=delete
	Noncopyable.
	StaticDecoder (StaticDecoder &&)
	Move constructor.
StaticDecoder &	operator= (StaticDecoder &&)
	Move assignment operator.
Element	getElement (const CodecIndex &codec_index) const
	Retrieves an element instance based on the codec index of that element. More...
Element	getElement (const std::string &full_element_name) const
	Retrieves an element instance based on the full name of the element. More...
const Elements &	getElements () const
	Retrieves the elements of the static decoder to get element information. More...
size_t	getElementChildCount (const CodecIndex &codec_index=CodecIndex()) const
	Retrieves the amount of child elements for the given codec index. More...
std::string	getElementFullName (const CodecIndex &codec_index) const
	Retrieves the full name of the element within its main structure. More...
std::string	getElementName (const CodecIndex &codec_index) const
	Retrieves the name of the element within its structured element. More...
const std::string &	getElementBaseName (const CodecIndex &codec_index) const
	Retrieves the base name of the element within its structured element. More...
template<typename T >
T	getElementValue (const CodecIndex &codec_index) const
	Returns the current value of the given element as a T if supported. More...
template<typename T >
T	getElementValue (const LeafCodecIndex &leaf_codec_index) const
	Returns the current value of the given element as a T if supported. More...
a_util::variant::Variant	getElementVariantValue (const CodecIndex &codec_index) const
	Returns the current value of the given element as a variant. More...
void	getElementVariantValue (const CodecIndex &codec_index, a_util::variant::Variant &value) const
	Returns the current value of the given element as a variant. More...
std::string	getElementStringValue (const CodecIndex &codec_index) const
	Returns the current value of the given element as a string. More...
void	getElementRawValue (const CodecIndex &index, void *value, size_t value_size) const
	Returns the current value of the given element as a variant. More...
const void *	getElementAddress (const CodecIndex &index) const
size_t	getStaticBufferSize () const
	Gets the static buffer size in bytes for the main structure. More...
size_t	getStaticBufferSize (DataRepresentation rep) const
	Gets the static buffer size in bytes for the main structure. More...
DataRepresentation	getRepresentation () const
	Returns the current data representation the decoder decodes from. More...
CodecIndex	resolve (size_t leaf_index) const
CodecIndex	resolve (size_t leaf_index, std::string &element_full_name) const
size_t	getElementCount () const
	is the leaf count More...
a_util::result::Result	getElement (size_t leaf_index, const ddl::StructElement *&legacy_struct_element) const
	Returns the StructElement of the element with given leaf index. More...
void	resolve (CodecIndex &codec_index) const
	The codec index will be resolved for fast access (layout will be set) More...
const void *	getData () const noexcept
	Get the current set data. More...
size_t	getDataSize () const noexcept
	Get the current size (in bytes) of the data. More...

Protected Member Functions
	Codec (std::shared_ptr< const StructAccess > codec_access, void *data, size_t data_size, ddl::DataRepresentation rep)
	For internal use only.
	Codec (const Decoder &decoder, void *data, size_t data_size, ddl::DataRepresentation representation)
	For internal use only.
Protected Member Functions inherited from Decoder
	Decoder (std::shared_ptr< const StructAccess > codec_access, const void *data, size_t data_size, DataRepresentation representation)
	For internal use only.
	Decoder (const Decoder &decoder, const void *data, size_t data_size, DataRepresentation representation)
	For internal use only.
Protected Member Functions inherited from StaticDecoder
	StaticDecoder (std::shared_ptr< const StructAccess > codec_access, const void *data, size_t data_size, DataRepresentation representation)
	For internal use only.

Private Attributes
Element	_first_element

Additional Inherited Members
Protected Attributes inherited from 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

Decoder for dynamic structures defined by a DataDefinition definition.

Currently the amount of dynamic elements is determined during construction only (by the current values in the structure).

Definition at line 148 of file workspace/conan/dev_essential/1.4.3/dw/stable/package/aef85909f792a5a628750d25016a24323084963f/include/ddl/codec/codec.h.

Member Typedef Documentation

Elements

typedef ChildElements<CodecElementAccess<Codec> > Elements

Iterator container to iterate all elements of the codec.

See also

forEachLeafElement, forEachElement

ddl::codec::ChildElements, Codec::Element

Definition at line 208 of file workspace/conan/dev_essential/1.4.3/dw/stable/package/aef85909f792a5a628750d25016a24323084963f/include/ddl/codec/codec.h.

Member Function Documentation

getData()

void* getData ( )

noexcept

Get the current set data.

Remarks

For performance issues this will not check any validity!

Returns

void* The data pointer

Referenced by Codec::setElementValue().

getElement() [1/4]

Element 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 codec exists.

Exceptions

throws

std::runtime_error if not found.

getElement() [2/4]

Element getElement

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

Parameters

[in]

codec_index

The codec index.

Returns

The DecoderElement for the given codec index.

Remarks

The element is only valid as long as the factory exists.

Exceptions

throws

std::runtime_error if not found.

getElement() [3/4]

Element getElement

(

const std::string &

full_element_name

)

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

Parameters

[in]

full_element_name

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 codec exists.

Exceptions

throws

std::runtime_error if not found.

getElement() [4/4]

Element getElement

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

Parameters

[in]

full_element_name

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 factory exists.

Exceptions

throws

std::runtime_error if not found.

getElementAddress()

void* getElementAddress

(

const CodecIndex &

codec_index

)

Parameters

[in]

codec_index

The index of the element.

Returns

A pointer to the element for write access.

getElements() [1/2]

Elements& getElements

(

)

Retrieves the elements of the codec to get element information.

Returns

Elements The elements iterator container.

See also

forEachLeafElement, forEachElement, Codec::Element, CodecIndex

getElements() [2/2]

const Elements& getElements

Retrieves the elements of the decoder to get element information and get values.

Returns

Elements The elements iterator container.

See also

forEachLeafElement, forEachElement, Decoder::Element, CodecIndex

resetValues()

void 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 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	The size in bytes of the location (if 0 - unsafe usage!).

Exceptions

throws

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

setElementStringValue()

void 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]

void 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.

Definition at line 224 of file workspace/conan/dev_essential/1.4.3/dw/stable/package/aef85909f792a5a628750d25016a24323084963f/include/ddl/codec/codec.h.

References ValueSetterSelect< CodecType, ValueType, is_supported_leaf_type >::setValue().

setElementValue() [2/2]

void 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

Definition at line 238 of file workspace/conan/dev_essential/1.4.3/dw/stable/package/aef85909f792a5a628750d25016a24323084963f/include/ddl/codec/codec.h.

References Codec::getData(), StaticDecoder::getDataSize(), LeafCodecIndex::getLayout(), and LeafValueSetter< ValueType >::setValue().

setElementVariantValue()

void 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.