ADTF  3.18.2
sample_codec_factory_access< AccessType >

Implementation for codec access concept (ddl::codec::FactoryElementAccess). More...

Public Types

typedef AccessType access_type
 Used access type.
 
typedef tCodecIndex index_type
 Used index type.
 
typedef ddl::codec::FactoryElement< sample_codec_factory_access< AccessType > > element_type
 supported element type.
 

Static Public Member Functions

static element_type getElement (const access_type &access, const std::string &full_element_name)
 Get a element object for the given full_element_name. More...
 
static element_type getElement (const access_type &access, const index_type &index)
 Get a element object for the given index. More...
 
static size_t getChildCount (const access_type &access, const index_type &index)
 Get the Child Count. More...
 
static std::string getFullName (access_type &access, const index_type &index)
 Get the full name of the element within its main structure. More...
 
static std::string getName (const access_type &access, const index_type &index)
 Get the name of the element within its level structure. More...
 
static std::string getBaseName (const access_type &access, const index_type &index)
 Get the name of the element within its level structure. More...
 
static void resolve (access_type &access, index_type &index)
 Resolves the given CodecIndex and set the layout information. More...
 

Detailed Description

template<typename AccessType>
class adtf::mediadescription::osborn::sample_codec_factory_access< AccessType >

Implementation for codec access concept (ddl::codec::FactoryElementAccess).

Template Parameters
AccessTypeThe adtf access type to use.

Definition at line 315 of file sample_codec_access_types.h.

Member Function Documentation

◆ getBaseName()

static std::string getBaseName ( const access_type access,
const index_type index 
)
inlinestatic

Get the name of the element within its level structure.

If the element is an array you get the elements base name respresentation : "element_name" for each array element. If the element is not an array you get the elements name respresentation is also the base name respresentation: "element_name".

Parameters
accessdefined access type.
indexThe codec index
Returns
std::string

Definition at line 398 of file sample_codec_access_types.h.

◆ getChildCount()

static size_t getChildCount ( const access_type access,
const index_type index 
)
inlinestatic

Get the Child Count.

Parameters
accessdefined access type.
indexThe codec index
Returns
size_t

Definition at line 359 of file sample_codec_access_types.h.

◆ getElement() [1/2]

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

Get a element object for the given index.

Parameters
accessdefined access type.
indexThe codec index.
Returns
element_type

Definition at line 348 of file sample_codec_access_types.h.

◆ getElement() [2/2]

static element_type getElement ( const 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 337 of file sample_codec_access_types.h.

◆ getFullName()

static std::string getFullName ( access_type access,
const index_type index 
)
inlinestatic

Get the full name of the element within its main structure.

If the element is an array you get the elements array name respresentation: "main_element.element_name[0]" or main_element.element_name[1] ... etc. If the element is not an array you get the elements name respresentation: "main_element.element_name".

Parameters
accessdefined access type.
indexThe codec index
Returns
std::string

Definition at line 372 of file sample_codec_access_types.h.

◆ getName()

static std::string getName ( const access_type access,
const index_type index 
)
inlinestatic

Get the name of the element within its level structure.

If the element is an array you get the elements array name respresentation: "element_name[0]" or element_name[1] ... etc. If the element is not an array you get the elements name respresentation: "element_name".

Parameters
accessdefined access type.
indexThe codec index
Returns
std::string

Definition at line 385 of file sample_codec_access_types.h.

◆ resolve()

static void resolve ( access_type access,
index_type index 
)
inlinestatic

Resolves the given CodecIndex and set the layout information.

Parameters
accessdefined access type.
indexThe codec index to resolve
Exceptions
throwsif not found

Definition at line 410 of file sample_codec_access_types.h.