ADTF
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
CodecElementAccess< AccessType >

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

#include <codec_iterator.h>

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.
 
static element_type getElement (access_type &access, const CodecIndex &index)
 Get a element object for the given index.
 
template<typename T>
static void setValue (access_type &access, const CodecIndex &index, const T &value)
 Sets the value from value of type T.
 
static void setVariantValue (access_type &access, const CodecIndex &index, const a_util::variant::Variant &value)
 Sets the value from value as variant.
 
static void setStringValue (access_type &access, const CodecIndex &index, const std::string &value)
 Sets the value from value as string.
 
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.
 
static void * getAddress (access_type &access, const CodecIndex &index)
 Get the address (with write access)
 
- 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.
 
static element_type getElement (access_type &access, const CodecIndex &index)
 Get a element object for the given index.
 
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 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.
 
static element_type getElement (access_type &access, const CodecIndex &index)
 Get a element object for the given index.
 
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.
 
static std::string getName (access_type &access, const CodecIndex &index)
 Get the name of the element within its level structure.
 
static std::string getBaseName (access_type &access, const CodecIndex &index)
 Get the name of the element within its level structure.
 
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::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 1086 of file codec_iterator.h.

Member Typedef Documentation

◆ access_type

template<typename AccessType>
using access_type = AccessType

access type

Definition at line 1088 of file codec_iterator.h.

◆ element_type

template<typename AccessType>
using element_type = CodecElement<self_type, ChildElements<self_type>>

supported element type

Definition at line 1091 of file codec_iterator.h.

◆ self_type

template<typename AccessType>
using self_type = CodecElementAccess<AccessType>

self type

Definition at line 1089 of file codec_iterator.h.

Member Function Documentation

◆ getAddress()

template<typename AccessType>
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 1179 of file codec_iterator.h.

◆ getElement() [1/2]

template<typename AccessType>
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 1112 of file codec_iterator.h.

◆ getElement() [2/2]

template<typename AccessType>
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 1101 of file codec_iterator.h.

◆ setRawValue()

template<typename AccessType>
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
setElementRawValue

Definition at line 1165 of file codec_iterator.h.

◆ setStringValue()

template<typename AccessType>
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
setElementStringValue

Definition at line 1151 of file codec_iterator.h.

◆ setValue()

template<typename AccessType>
template<typename T>
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
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
setElementValue

Definition at line 1127 of file codec_iterator.h.

◆ setVariantValue()

template<typename AccessType>
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
setElementVariantValue

Definition at line 1138 of file codec_iterator.h.