ADTF  3.15.1
CodecElementAccess< AccessType >

A element access type concept template to retrieve element information from the AccessType, get and set the element value. More...

Inheritance diagram for CodecElementAccess< AccessType >:
[legend]

Public Types

using access_type = AccessType
 access type
 
using self_type = CodecElementAccess< AccessType >
 self type
 
using element_type = CodecElement< self_type, ChildElements< self_type > >
 supported element type
 
- Public Types inherited from DecoderElementAccess< AccessType >
using access_type = AccessType
 access type in use
 
using self_type = DecoderElementAccess< AccessType >
 self type
 
using element_type = DecoderElement< self_type, ChildElements< self_type > >
 supported element type
 
- Public Types inherited from 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, const std::string &full_element_name)
 Get a element object for the given full_element_name. More...
 
static element_type getElement (access_type &access, const CodecIndex &index)
 Get a element object for the given index. More...
 
template<typename T >
static void setValue (access_type &access, const CodecIndex &index, const T &value)
 Sets the value from value of type T. More...
 
static void setVariantValue (access_type &access, const CodecIndex &index, const a_util::variant::Variant &value)
 Sets the value from value as variant. More...
 
static void setStringValue (access_type &access, const CodecIndex &index, const std::string &value)
 Sets the value from value as string. More...
 
static void setRawValue (access_type &access, const CodecIndex &index, const void *value, size_t value_size)
 Set the value by copying from a value buffer. More...
 
static void * getAddress (access_type &access, const CodecIndex &index)
 Get the address (with write access) More...
 
- Static Public Member Functions inherited from DecoderElementAccess< AccessType >
static element_type getElement (access_type &access, const std::string &full_element_name)
 Get a element object for the given full_element_name. More...
 
static element_type getElement (access_type &access, const CodecIndex &index)
 Get a element object for the given index. More...
 
template<typename T >
static T getValue (access_type &access, const CodecIndex &index)
 Get the value as type T. More...
 
static a_util::variant::Variant getVariantValue (access_type &access, const CodecIndex &index)
 Get the value as variant. More...
 
static std::string getStringValue (access_type &access, const CodecIndex &index)
 Get the value as type string. More...
 
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. More...
 
static const void * getAddress (access_type &access, const CodecIndex &index)
 Get the address of the element. More...
 
- Static Public Member Functions inherited from FactoryElementAccess< AccessType >
static element_type getElement (access_type &access, const std::string &full_element_name)
 Get a element object for the given full_element_name. More...
 
static element_type getElement (access_type &access, const CodecIndex &index)
 Get a element object for the given index. More...
 
static size_t getChildCount (access_type &access, const CodecIndex &index)
 Get the Child Count. More...
 
static std::string getFullName (access_type &access, const CodecIndex &index)
 Get the full name of the element within its main structure. More...
 
static std::string getName (access_type &access, const CodecIndex &index)
 Get the name of the element within its level structure. More...
 
static std::string getBaseName (access_type &access, const CodecIndex &index)
 Get the name of the element within its level structure. More...
 
static void resolve (access_type &access, CodecIndex &index)
 Resolves the given CodecIndex and set the layout information. More...
 

Detailed Description

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

A element access type concept template to retrieve element information from the AccessType, get and set the element value.

This class is to retrieve common information of the element, get and set the element value content.

See also
CodecElement.
Template Parameters
AccessTypeThe AccessType for the element (Codec, StaticCodec, etc. )

Definition at line 1092 of file codec_iterator.h.

Member Function Documentation

◆ getAddress()

static void* getAddress ( access_type access,
const CodecIndex index 
)
inlinestatic

Get the address (with write access)

Parameters
accessdefined access type.
indexThe codec index.
Returns
void*

Definition at line 1186 of file codec_iterator.h.

◆ getElement() [1/2]

static element_type getElement ( access_type access,
const CodecIndex index 
)
inlinestatic

Get a element object for the given index.

Parameters
accessdefined access type.
indexThe codec index.
Returns
element_type

Definition at line 1118 of file codec_iterator.h.

◆ getElement() [2/2]

static element_type getElement ( access_type access,
const std::string &  full_element_name 
)
inlinestatic

Get a element object for the given full_element_name.

Parameters
accessdefined access type.
full_element_nameThe full name of the element in point notation (i.e. "element1.child_element[4].element_value").
Returns
element_type

Definition at line 1107 of file codec_iterator.h.

◆ setRawValue()

static void setRawValue ( access_type access,
const CodecIndex index,
const void *  value,
size_t  value_size 
)
inlinestatic

Set the value by copying from a value buffer.

Parameters
accessdefined access type.
indexThe codec index.
valueThe value buffer
value_sizethe size of the value buffer in bytes.
See also
StaticCodec::setElementRawValue

Definition at line 1172 of file codec_iterator.h.

◆ setStringValue()

static void setStringValue ( access_type access,
const CodecIndex index,
const std::string &  value 
)
inlinestatic

Sets the value from value as string.

Parameters
[in]accessThe access type
[in]indexThe codec index of the value
[in]valueThe value to set as string. string will be converted to the elements type.
See also
StaticCodec::setElementStringValue

Definition at line 1158 of file codec_iterator.h.

◆ setValue()

static void setValue ( access_type access,
const CodecIndex index,
const T &  value 
)
inlinestatic

Sets the value from value of type T.

Template Parameters
TType of the value
Parameters
[in]accessThe access type
[in]indexThe codec index of the value
[in]valueThe value in type T
Returns
value in type T (supported types: all int types, bool, float, double, std::string)
Remarks
for T = std::string the value can be set as valid element name in case of enum type otherwise the string is converted
See also
StaticCodec::setElementValue

Definition at line 1134 of file codec_iterator.h.

◆ setVariantValue()

static void setVariantValue ( access_type access,
const CodecIndex index,
const a_util::variant::Variant value 
)
inlinestatic

Sets the value from value as variant.

Parameters
[in]accessThe access type
[in]indexThe codec index of the value
[in]valueThe value to set as variant
See also
StaticCodec::setElementVariantValue

Definition at line 1145 of file codec_iterator.h.