adtf::mediadescription::ant::cSampleCodecFactory Class Reference

#include <sample_codec_legacy.h>

Inherited by adtf::mediadescription::flash::cSampleCodecFactory.

Public Member Functions
	cSampleCodecFactory ()=default
	cSampleCodecFactory (const char *strStructName, const char *strMediaDescription, adtf_ddl::tDataRepresentation eDefaultDataRepresentation=adtf_ddl::tDataRepresentation::Deserialized)
	cSampleCodecFactory (const adtf_ddl::cDDLComplex *pStruct, adtf_ddl::tDataRepresentation eDefaultDataRepresentation=adtf_ddl::tDataRepresentation::Deserialized)
	cSampleCodecFactory (cSampleCodecFactory &)=default
	cSampleCodecFactory (const cSampleCodecFactory &)=default
	cSampleCodecFactory (cSampleCodecFactory &&)=default
cSampleCodecFactory &	operator= (cSampleCodecFactory &)=default
cSampleCodecFactory &	operator= (cSampleCodecFactory &&)=default
tResult	IsValid () const
cStaticSampleDecoder	MakeStaticDecoderFor (const adtf::streaming::ISample &oSample, adtf_ddl::tDataRepresentation eDataRepresentation) const
cStaticSampleCodec	MakeStaticCodecFor (adtf::streaming::ISample &oSample, adtf_ddl::tDataRepresentation eDataRepresentation) const
cSampleDecoder	MakeDecoderFor (const adtf::streaming::ISample &oSample, adtf_ddl::tDataRepresentation eDataRepresentation) const
cSampleCodec	MakeCodecFor (adtf::streaming::ISample &oSample, adtf_ddl::tDataRepresentation eDataRepresentation) const
size_t	GetStaticElementCount () const
tResult	GetStaticElement (size_t nIndex, const adtf_ddl::tStructElement *&pElement) const
size_t	GetStaticBufferSize (adtf_ddl::tDataRepresentation eRep=adtf_ddl::tDataRepresentation::Deserialized) const
adtf_ddl::tDataRepresentation	GetDefaultDataRepresentation () const
cStaticSampleDecoder	MakeStaticDecoderFor (const adtf::ucom::iobject_ptr< const adtf::streaming::ISample > &pSample, adtf_ddl::tDataRepresentation eDataRepresentation) const
cSampleDecoder	MakeDecoderFor (const adtf::ucom::iobject_ptr< const adtf::streaming::ISample > &pSample, adtf_ddl::tDataRepresentation eDataRepresentation) const
cStaticSampleCodec	MakeStaticCodecFor (const adtf::ucom::iobject_ptr< adtf::streaming::ISample > &pSample, adtf_ddl::tDataRepresentation eDataRepresentation) const
cSampleCodec	MakeCodecFor (const adtf::ucom::iobject_ptr< adtf::streaming::ISample > &pSample, adtf_ddl::tDataRepresentation eDataRepresentation) const
cStaticSampleDecoder	MakeStaticDecoderFor (const adtf::ucom::iobject_ptr< const adtf::streaming::ISample > &pSample) const
cSampleDecoder	MakeDecoderFor (const adtf::ucom::iobject_ptr< const adtf::streaming::ISample > &pSample) const
cStaticSampleCodec	MakeStaticCodecFor (const adtf::ucom::iobject_ptr< adtf::streaming::ISample > &pSample) const
cSampleCodec	MakeCodecFor (const adtf::ucom::iobject_ptr< adtf::streaming::ISample > &pSample) const
cStaticSampleDecoder	MakeStaticDecoderFor (const adtf::streaming::ISample &oSample) const
cSampleDecoder	MakeDecoderFor (const adtf::streaming::ISample &oSample) const
cStaticSampleCodec	MakeStaticCodecFor (adtf::streaming::ISample &oSample) const
cSampleCodec	MakeCodecFor (adtf::streaming::ISample &oSample) const

Detailed Description

(Legacy) Factory class for ddl codecs for samples.

Constructor & Destructor Documentation

cSampleCodecFactory() [1/6]

adtf::mediadescription::ant::cSampleCodecFactory::cSampleCodecFactory ( )

default

Empty constructor. This exists to enable uninitialized member variables of this type that are move-assigned later on.

cSampleCodecFactory() [2/6]

adtf::mediadescription::ant::cSampleCodecFactory::cSampleCodecFactory	(	const char *	strStructName,
		const char *	strMediaDescription,
		adtf_ddl::tDataRepresentation	eDefaultDataRepresentation = adtf_ddl::tDataRepresentation::Deserialized )

Constructor that take a DDL string for initialization.

Parameters

[in]	strStructName	The name of the struct for which codecs should be generated.
[in]	strMediaDescription	The DDL description.
[in]	eDefaultDataRepresentation	The representation used for the Make* factory methods without an parameter for the data representation.

cSampleCodecFactory() [3/6]

adtf::mediadescription::ant::cSampleCodecFactory::cSampleCodecFactory	(	const adtf_ddl::cDDLComplex *	pStruct,
		adtf_ddl::tDataRepresentation	eDefaultDataRepresentation = adtf_ddl::tDataRepresentation::Deserialized )

Constructor that uses an OO-DDL struct for initialization.

Parameters

[in]	pStruct	The struct definition.
[in]	eDefaultDataRepresentation	The representation used for the Make* factory methods without an parameter for the data representation.

cSampleCodecFactory() [4/6]

adtf::mediadescription::ant::cSampleCodecFactory::cSampleCodecFactory ( cSampleCodecFactory & )

default

Copy constructor

cSampleCodecFactory() [5/6]

adtf::mediadescription::ant::cSampleCodecFactory::cSampleCodecFactory ( const cSampleCodecFactory & )

default

Copy constructor

cSampleCodecFactory() [6/6]

adtf::mediadescription::ant::cSampleCodecFactory::cSampleCodecFactory ( cSampleCodecFactory && )

default

Move constructor

Member Function Documentation

GetDefaultDataRepresentation()

adtf_ddl::tDataRepresentation adtf::mediadescription::ant::cSampleCodecFactory::GetDefaultDataRepresentation

(

)

const

Returns

The default data representation used when creating codecs/decoders.

GetStaticBufferSize()

size_t adtf::mediadescription::ant::cSampleCodecFactory::GetStaticBufferSize

(

adtf_ddl::tDataRepresentation

eRep = adtf_ddl::tDataRepresentation::Deserialized

)

const

Parameters

[in]

eRep

The data representation for which the buffer size should be returned.

Returns

The size of the structure in the requested data representation.

GetStaticElement()

tResult adtf::mediadescription::ant::cSampleCodecFactory::GetStaticElement	(	size_t	nIndex,
		const adtf_ddl::tStructElement *&	pElement ) const

Access information about an element.

Parameters

[in]	nIndex	The index of the element.
[out]	pElement	Pointer that will be updated to point to the element information.

Return values

ERR_INVALID_INDEX

Invalid index.

GetStaticElementCount()

size_t adtf::mediadescription::ant::cSampleCodecFactory::GetStaticElementCount

(

)

const

Returns

The amount of static elements contained in the handled structure.

IsValid()

tResult adtf::mediadescription::ant::cSampleCodecFactory::IsValid

(

)

const

Check if the factory is in a valid state.

Returns

Any errors during construction.

MakeCodecFor() [1/4]

cSampleCodec adtf::mediadescription::ant::cSampleCodecFactory::MakeCodecFor ( adtf::streaming::ISample & oSample ) const

inline

Creates a codec for the given sample using the default data representation.

Parameters

[in]

oSample

The sample.

Returns

a codec.

MakeCodecFor() [2/4]

cSampleCodec adtf::mediadescription::ant::cSampleCodecFactory::MakeCodecFor	(	adtf::streaming::ISample &	oSample,
		adtf_ddl::tDataRepresentation	eDataRepresentation ) const

Creates a codec for the given sample.

Parameters

[out]	oSample	The sample.
[in]	eDataRepresentation	The data representation that the sample is in.

Returns

a codec.

MakeCodecFor() [3/4]

cSampleCodec adtf::mediadescription::ant::cSampleCodecFactory::MakeCodecFor ( const adtf::ucom::iobject_ptr< adtf::streaming::ISample > & pSample ) const

inline

Creates a codec for the given sample using the default data representation.

Parameters

[in]

pSample

The sample.

Returns

a codec.

MakeCodecFor() [4/4]

cSampleCodec adtf::mediadescription::ant::cSampleCodecFactory::MakeCodecFor ( const adtf::ucom::iobject_ptr< adtf::streaming::ISample > & pSample, adtf_ddl::tDataRepresentation eDataRepresentation ) const

inline

Creates a codec for the given sample.

Parameters

[out]	pSample	The sample.
[in]	eDataRepresentation	The data representation that the sample is in.

Returns

a codec.

MakeDecoderFor() [1/4]

cSampleDecoder adtf::mediadescription::ant::cSampleCodecFactory::MakeDecoderFor ( const adtf::streaming::ISample & oSample ) const

inline

Creates a decoder for the given sample using the default data representation.

Parameters

[in]

oSample

The sample.

Returns

a decoder.

MakeDecoderFor() [2/4]

cSampleDecoder adtf::mediadescription::ant::cSampleCodecFactory::MakeDecoderFor	(	const adtf::streaming::ISample &	oSample,
		adtf_ddl::tDataRepresentation	eDataRepresentation ) const

Creates a decoder for the given sample.

Parameters

[in]	oSample	The sample.
[in]	eDataRepresentation	The data representation that the sample is in.

Returns

a decoder.

MakeDecoderFor() [3/4]

cSampleDecoder adtf::mediadescription::ant::cSampleCodecFactory::MakeDecoderFor ( const adtf::ucom::iobject_ptr< const adtf::streaming::ISample > & pSample ) const

inline

Creates a decoder for the given sample using the default data representation.

Parameters

[in]

pSample

The sample.

Returns

a decoder.

MakeDecoderFor() [4/4]

cSampleDecoder adtf::mediadescription::ant::cSampleCodecFactory::MakeDecoderFor ( const adtf::ucom::iobject_ptr< const adtf::streaming::ISample > & pSample, adtf_ddl::tDataRepresentation eDataRepresentation ) const

inline

Creates a decoder for the given sample.

Parameters

[in]	pSample	The sample.
[in]	eDataRepresentation	The data representation that the sample is in.

Returns

a decoder.

MakeStaticCodecFor() [1/4]

cStaticSampleCodec adtf::mediadescription::ant::cSampleCodecFactory::MakeStaticCodecFor ( adtf::streaming::ISample & oSample ) const

inline

Creates a static codec for the given sample using the default data representation.

Parameters

[in]

oSample

The sample.

Returns

a static codec.

MakeStaticCodecFor() [2/4]

cStaticSampleCodec adtf::mediadescription::ant::cSampleCodecFactory::MakeStaticCodecFor	(	adtf::streaming::ISample &	oSample,
		adtf_ddl::tDataRepresentation	eDataRepresentation ) const

Creates a static codec for the given sample.

Parameters

[out]	oSample	The sample.
[in]	eDataRepresentation	The data representation that the sample is in.

Returns

a static codec.

MakeStaticCodecFor() [3/4]

cStaticSampleCodec adtf::mediadescription::ant::cSampleCodecFactory::MakeStaticCodecFor ( const adtf::ucom::iobject_ptr< adtf::streaming::ISample > & pSample ) const

inline

Creates a static codec for the given sample using the default data representation.

Parameters

[in]

pSample

The sample.

Returns

a static codec.

MakeStaticCodecFor() [4/4]

cStaticSampleCodec adtf::mediadescription::ant::cSampleCodecFactory::MakeStaticCodecFor ( const adtf::ucom::iobject_ptr< adtf::streaming::ISample > & pSample, adtf_ddl::tDataRepresentation eDataRepresentation ) const

inline

Creates a static codec for the given sample.

Parameters

[out]	pSample	The sample.
[in]	eDataRepresentation	The data representation that the sample is in.

Returns

a static codec.

MakeStaticDecoderFor() [1/4]

cStaticSampleDecoder adtf::mediadescription::ant::cSampleCodecFactory::MakeStaticDecoderFor ( const adtf::streaming::ISample & oSample ) const

inline

Creates a static decoder for the given sample using the default data representation.

Parameters

[in]

oSample

The sample.

Returns

a static decoder.

MakeStaticDecoderFor() [2/4]

cStaticSampleDecoder adtf::mediadescription::ant::cSampleCodecFactory::MakeStaticDecoderFor	(	const adtf::streaming::ISample &	oSample,
		adtf_ddl::tDataRepresentation	eDataRepresentation ) const

Creates a static decoder for the given sample.

Parameters

[in]	oSample	The sample.
[in]	eDataRepresentation	The data representation that the sample is in.

Returns

a static decoder.

MakeStaticDecoderFor() [3/4]

cStaticSampleDecoder adtf::mediadescription::ant::cSampleCodecFactory::MakeStaticDecoderFor ( const adtf::ucom::iobject_ptr< const adtf::streaming::ISample > & pSample ) const

inline

Creates a static decoder for the given sample using the default data representation.

Parameters

[in]

pSample

The sample.

Returns

a static decoder.

MakeStaticDecoderFor() [4/4]

cStaticSampleDecoder adtf::mediadescription::ant::cSampleCodecFactory::MakeStaticDecoderFor ( const adtf::ucom::iobject_ptr< const adtf::streaming::ISample > & pSample, adtf_ddl::tDataRepresentation eDataRepresentation ) const

inline

Creates a static decoder for the given sample.

Parameters

[in]	pSample	The sample.
[in]	eDataRepresentation	The data representation that the sample is in.

Returns

a static decoder.

operator=() [1/2]

cSampleCodecFactory & adtf::mediadescription::ant::cSampleCodecFactory::operator= ( cSampleCodecFactory && )

default

Move assignment operator

operator=() [2/2]

cSampleCodecFactory & adtf::mediadescription::ant::cSampleCodecFactory::operator= ( cSampleCodecFactory & )

default

assignment operator

---

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

• src/libraries/mediadescription/include/adtfmediadescription/legacy/sample_codec_legacy.h