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

#include <sample_codec_access_types.h>

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, std::string_view full_element_name)
	Get a element object for the given `full_element_name`.

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

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

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

static std::string	getFullName (access_type &access, const index_type &index)
	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".

static std::string	getName (const access_type &access, const index_type &index)
	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".

static std::string	getBaseName (const access_type &access, const index_type &index)
	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".

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

Detailed Description

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

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

Template Parameters

AccessType The adtf access type to use.

Member Function Documentation

◆ getBaseName()

template<typename AccessType>

static std::string adtf::mediadescription::osborn::sample_codec_factory_access< AccessType >::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

access	defined access type.
index	The codec index

Returns: std::string

◆ getChildCount()

template<typename AccessType>

static size_t adtf::mediadescription::osborn::sample_codec_factory_access< AccessType >::getChildCount	(	const access_type &	access,
		const index_type &	index )

inlinestatic

Get the Child Count.

Parameters

access	defined access type.
index	The codec index

Returns: size_t

◆ getChildElement()

template<typename AccessType>

static element_type adtf::mediadescription::osborn::sample_codec_factory_access< AccessType >::getChildElement	(	const access_type &	access,
		const index_type &	parent_index,
		std::string_view	element_path )

inlinestatic

Get a child element object for the given index.

Parameters

access	defined access type.
index	The codec index of the parent.
element_path	The child element path.

Returns: element_type

◆ getElement() [1/2]

template<typename AccessType>

static element_type adtf::mediadescription::osborn::sample_codec_factory_access< AccessType >::getElement	(	const access_type &	access,
		const index_type &	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 adtf::mediadescription::osborn::sample_codec_factory_access< AccessType >::getElement	(	const access_type &	access,
		std::string_view	full_element_name )

inlinestatic

Get a element object for the given full_element_name.

Parameters

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

Returns: element_type

◆ getFullName()

template<typename AccessType>

static std::string adtf::mediadescription::osborn::sample_codec_factory_access< AccessType >::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

access	defined access type.
index	The codec index

Returns: std::string

◆ getName()

template<typename AccessType>

static std::string adtf::mediadescription::osborn::sample_codec_factory_access< AccessType >::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

access	defined access type.
index	The codec index

Returns: std::string

◆ resolve()

template<typename AccessType>

static void adtf::mediadescription::osborn::sample_codec_factory_access< AccessType >::resolve	(	access_type &	access,
		index_type &	index )

inlinestatic

Resolves the given CodecIndex and set the layout information.

Parameters

access	defined access type.
index	The codec index to resolve

Exceptions

throws if not found

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

src/libraries/mediadescription/include/adtfmediadescription/sample_codec_access_types.h

Public Types

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ getBaseName()

◆ getChildCount()

◆ getChildElement()

◆ getElement() [1/2]

◆ getElement() [2/2]

◆ getFullName()

◆ getName()

◆ resolve()