ADTF  3.14.3
cDecoderLegacyabstract

Legacy Base Class to Support adtf_ddl::access_element API. More...

Inheritance diagram for cDecoderLegacy:
[legend]

Public Types

typedef ddl::StructElement DefinedStructElementType
 type definition for the old access_element API.
 

Public Member Functions

tCodecIndex Resolve (tCodecLeafIndex nElementLeafIndex) const
 Legacy: Retrieves a codec index with element information for the given leaf index. More...
 
adtf_util::cVariant GetElementValue (tCodecLeafIndex nElementLeafIndex) const
 Legacy: Get the Element Value. More...
 
tResult GetElementValue (tCodecLeafIndex nElementLeafIndex, adtf_util::cVariant &oValue) const
 Legacy: Get the Element Value. More...
 
tResult GetElementValue (const char *strElementName, adtf_util::cVariant &oValue) const
 Legacy: Get the Element Value. More...
 
tResult GetElementValue (tCodecLeafIndex nElementLeafIndex, void *pValue) const
 Legacy: Copies the Element Value memory into the memory pointer. More...
 
tResult GetElementValue (const char *strElementName, void *pValue) const
 Legacy: Get the Element Value pointer. More...
 
adtf_util::cString GetElementValueString (tCodecLeafIndex nElementLeafIndex) const
 Legacy: Get the Element Value as string (resolved to the enum element name if is enum type) More...
 
tResult GetElement (tCodecLeafIndex nElementLeafIndex, const ddl::StructElement *&pElement) const
 Get the Element StructElement information. More...
 
const void * GetElementAddress (tCodecLeafIndex nElementIndex) const
 Legacy: Get the Element StructElement information. More...
 
size_t GetElementCount () const
 Legacy: Get the Element Leaf count. More...
 

Static Public Member Functions

static const char * GetStructElementName (const ddl::StructElement *pElement)
 Legacy: Get the Struct Element Name for access_element legacy support. More...
 

Protected Member Functions

virtual const ddl::codec::StaticDecodergetDecoder () const =0
 Get the base ddl::Decoder. More...
 

Detailed Description

Legacy Base Class to Support adtf_ddl::access_element API.

See also
The Codec Leaf Index.

Definition at line 29 of file sample_codec_access_legacy.h.

Member Function Documentation

◆ getDecoder()

virtual const ddl::codec::StaticDecoder* getDecoder ( ) const
protectedpure virtual

◆ GetElement()

tResult GetElement ( tCodecLeafIndex  nElementLeafIndex,
const ddl::StructElement *&  pElement 
) const

Get the Element StructElement information.

Parameters
nElementLeafIndexThe leaf index (between 0 and GetElementCount())
pElementThe legacy StructElement
Returns
tResult
Remarks
This function does not throw! DO NOT STORE and reuse after another GetElement call!

◆ GetElementAddress()

const void* GetElementAddress ( tCodecLeafIndex  nElementIndex) const

Legacy: Get the Element StructElement information.

Parameters
nElementLeafIndexThe leaf index (between 0 and GetElementCount())
pElementThe legacy StructElement
Returns
tResult
Remarks
This function does not throw! DO NOT STORE and reuse after another GetElement call!

◆ GetElementCount()

size_t GetElementCount ( ) const

Legacy: Get the Element Leaf count.

Returns
size_t The amount of leafs.

◆ GetElementValue() [1/5]

tResult GetElementValue ( const char *  strElementName,
adtf_util::cVariant &  oValue 
) const

Legacy: Get the Element Value.

Parameters
strElementNameThe full element name
oValueThe result value to retrieve to
Returns
tResult
Remarks
This function does not throw! Use the new function with std::string parameter!

◆ GetElementValue() [2/5]

tResult GetElementValue ( const char *  strElementName,
void *  pValue 
) const

Legacy: Get the Element Value pointer.

Parameters
strElementNameThe full element name
pValueThe result value pointer to retrieve to
Returns
tResult
Remarks
This function does not throw! Use the new function with std::string parameter!

◆ GetElementValue() [3/5]

adtf_util::cVariant GetElementValue ( tCodecLeafIndex  nElementLeafIndex) const

Legacy: Get the Element Value.

Parameters
nElementLeafIndexThe leaf index (between 0 and GetElementCount())
Returns
adtf_util::cVariant
Exceptions
Throwsa tResult if not found.

◆ GetElementValue() [4/5]

tResult GetElementValue ( tCodecLeafIndex  nElementLeafIndex,
adtf_util::cVariant &  oValue 
) const

Legacy: Get the Element Value.

Parameters
nElementLeafIndexThe leaf index (between 0 and GetElementCount())
oValueThe result value to retrieve to
Returns
tResult
Remarks
This function does not throw!

◆ GetElementValue() [5/5]

tResult GetElementValue ( tCodecLeafIndex  nElementLeafIndex,
void *  pValue 
) const

Legacy: Copies the Element Value memory into the memory pointer.

Keep in MIND this function is UNSAFE in case of value memory is biger than the given one.

Parameters
nElementLeafIndexThe leaf index (between 0 and GetElementCount())
pValueThe result value pointer to retrieve to
Returns
tResult
Remarks
This function does not throw! Use the new function with std::string parameter!

◆ GetElementValueString()

adtf_util::cString GetElementValueString ( tCodecLeafIndex  nElementLeafIndex) const

Legacy: Get the Element Value as string (resolved to the enum element name if is enum type)

Parameters
nElementLeafIndexThe leaf index (between 0 and GetElementCount())
Returns
adtf_util::cString
Remarks
This function does not throw!

◆ GetStructElementName()

static const char* GetStructElementName ( const ddl::StructElement pElement)
static

Legacy: Get the Struct Element Name for access_element legacy support.

Parameters
pElementthe struct element where to retrieve the name from
Returns
const char*

◆ Resolve()

tCodecIndex Resolve ( tCodecLeafIndex  nElementLeafIndex) const

Legacy: Retrieves a codec index with element information for the given leaf index.

Parameters
nElementLeafIndexThe leaf index (between 0 and GetElementCount())
Returns
The codec index for this element.
Exceptions
throwstResult if not found.
Deprecated:
This is only provided for legacy reason. Use adtf::mediadescription::cSampleDecoder::GetElement!

Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Thu Jun 9 2022 by doxygen 1.9.1)