A element access type concept template to retrieve element information from the AccessType and get the element value. This class is to retrieve common information of the element and get the element value content. More...

#include <codec_iterator.h>

Inherits ddl::codec::FactoryElementAccess< AccessType >.

Inherited by ddl::codec::CodecElementAccess< AccessType >.

Public Types
using	access_type = AccessType
	access type in use

using	self_type = DecoderElementAccess<AccessType>

using	element_type = DecoderElement<self_type, ChildElements<self_type>>
	supported element type

Public Types inherited from ddl::codec::FactoryElementAccess< AccessType >
using	access_type = AccessType
	The access type (CodecFactory, Codec, Decoder, etc.)

using	self_type = FactoryElementAccess<AccessType>
	self type

using	element_type = FactoryElement<self_type, ChildElements<self_type>>
	element type

Static Public Member Functions
static element_type	getElement (access_type &access, std::string_view full_path)
	Get a element object for the given `full_element_name`.

static element_type	getElement (access_type &access, const CodecIndex &index)
	Get a element object for the given `index`.

static element_type	getChildElement (access_type &access, const CodecIndex &parent_index, std::string_view relative_path)
	Get a child element object for the given `element_name`.

template<typename T>
static T	getValue (access_type &access, const CodecIndex &index)
	Get the value as type T.

static a_util::variant::Variant	getVariantValue (access_type &access, const CodecIndex &index)
	Get the value as variant.

static std::string	getStringValue (access_type &access, const CodecIndex &index)
	Get the value as type string.

static void	getRawValue (access_type &access, const CodecIndex &index, void *value, size_t value_size)
	Get the value by copy to the given `value` buffer.

static const void *	getAddress (access_type &access, const CodecIndex &index)
	Get the address of the element.

Static Public Member Functions inherited from ddl::codec::FactoryElementAccess< AccessType >
static element_type	getElement (access_type &access, std::string_view full_path)
	Get a element object for the given `full_element_name`.

static element_type	getElement (access_type &access, const CodecIndex &index)
	Get a element object for the given `index`.

static element_type	getChildElement (access_type &access, const CodecIndex &parent_index, std::string_view relative_path)
	Get a child element object for the given `element_name`.

static size_t	getChildCount (access_type &access, const CodecIndex &index)
	Get the Child Count.

static std::string	getFullName (access_type &access, const CodecIndex &index)
	Get the full name of the element within its main structure. If the element is an array you get the elements array name representation: "main_element.element_name[0]" or main_element.element_name[1] ... etc. If the element is not an array you get the elements name representation: "main_element.element_name".

static std::string	getName (access_type &access, const CodecIndex &index)
	Get the name of the element within its level structure. If the element is an array you get the elements array name representation: "element_name[0]" or element_name[1] ... etc. If the element is not an array you get the elements name representation: "element_name".

static std::string	getBaseName (access_type &access, const CodecIndex &index)
	Get the name of the element within its level structure. If the element is an array you get the elements base name representation : "element_name" for each array element. If the element is not an array you get the elements name representation is also the base name representation: "element_name".

static void	resolve (access_type &access, CodecIndex &index)
	Resolves the given CodecIndex and set the layout information.

Detailed Description

template<typename AccessType>
class ddl::codec::DecoderElementAccess< AccessType >

A element access type concept template to retrieve element information from the AccessType and get the element value. This class is to retrieve common information of the element and get the element value content.

See also: DecoderElement.

Template Parameters

AccessType The AccessType for the element (Codec, Decoder, etc. )

Member Typedef Documentation

◆ self_type

template<typename AccessType>

using ddl::codec::DecoderElementAccess< AccessType >::self_type = DecoderElementAccess<AccessType>

self type

Member Function Documentation

◆ getAddress()

template<typename AccessType>

static const void * ddl::codec::DecoderElementAccess< AccessType >::getAddress	(	access_type &	access,
		const CodecIndex &	index )

inlinestatic

Get the address of the element.

Parameters

access	defined access type.
index	The codec index.

Returns: const void*

◆ getChildElement()

template<typename AccessType>

static element_type ddl::codec::DecoderElementAccess< AccessType >::getChildElement	(	access_type &	access,
		const CodecIndex &	parent_index,
		std::string_view	relative_path )

inlinestatic

Get a child element object for the given element_name.

Parameters

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

Returns: element_type

◆ getElement() [1/2]

template<typename AccessType>

static element_type ddl::codec::DecoderElementAccess< AccessType >::getElement	(	access_type &	access,
		const CodecIndex &	index )

inlinestatic

Get a element object for the given index.

Parameters

access	defined access type.
index	The codec index.

Returns: element_type

◆ getElement() [2/2]

template<typename AccessType>

static element_type ddl::codec::DecoderElementAccess< AccessType >::getElement	(	access_type &	access,
		std::string_view	full_path )

inlinestatic

Get a element object for the given full_element_name.

Parameters

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

Returns: element_type

◆ getRawValue()

template<typename AccessType>

static void ddl::codec::DecoderElementAccess< AccessType >::getRawValue	(	access_type &	access,
		const CodecIndex &	index,
		void *	value,
		size_t	value_size )

inlinestatic

Get the value by copy to the given value buffer.

Parameters

access	defined access type.
index	The codec index.
value	the value buffer pointer.
value_size	the size of the value buffer in bytes.

◆ getStringValue()

template<typename AccessType>

static std::string ddl::codec::DecoderElementAccess< AccessType >::getStringValue	(	access_type &	access,
		const CodecIndex &	index )

inlinestatic

Get the value as type string.

Parameters

access	defined access type.
index	The codec index.

Returns: value as string, it is set to the enums element name in case of enum type

See also: StaticDecoder::getElementStringValue

◆ getValue()

template<typename AccessType>

template<typename T>

static T ddl::codec::DecoderElementAccess< AccessType >::getValue	(	access_type &	access,
		const CodecIndex &	index )

inlinestatic

Get the value as type T.

Parameters

access	defined access type.
index	The codec index.

Template Parameters

T	Type of the value to return

Returns: value in type T (supported types: all int types, bool, float, double, std::string)

Remarks: for T = std::string the value is returned as element name in case of enum type

See also: StaticCodec::getElementValue

◆ getVariantValue()

template<typename AccessType>

static a_util::variant::Variant ddl::codec::DecoderElementAccess< AccessType >::getVariantValue	(	access_type &	access,
		const CodecIndex &	index )

inlinestatic

Get the value as variant.

Parameters

access	defined access type.
index	The codec index.

Returns: value as variant converted from elements type

See also: StaticDecoder::getElementVariantValue

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

include/ddl/codec/codec_iterator.h

Public Types

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ self_type

Member Function Documentation

◆ getAddress()

◆ getChildElement()

◆ getElement() [1/2]

◆ getElement() [2/2]

◆ getRawValue()

◆ getStringValue()

◆ getValue()

◆ getVariantValue()