cCodecFactory

Factory class for ddl codecs. More...

#include <codec_factory.h>

Public Member Functions
	cCodecFactory ()
	Empty constructor.
	cCodecFactory (const char *strStructName, const char *strMediaDescription)
	Constructor that take a DDL string for initialization.
	cCodecFactory (const cDDLComplex *pStruct)
	Constructor that uses an OO-DDL struct for initialization.
	cCodecFactory (cCodecFactory &)=default
	Copy constructor.
	cCodecFactory (const cCodecFactory &)=default
	Copy constructor.
	cCodecFactory (cCodecFactory &&)=default
	Move constructor.
cCodecFactory &	operator= (cCodecFactory &)=default
	Assignment operator.
cCodecFactory &	operator= (cCodecFactory &&)=default
	Move assignment operator.
tResult	IsValid () const
	Check if the factory is in a valid state.
cStaticDecoder	MakeStaticDecoderFor (const void *pData, size_t nDataSize, tDataRepresentation eRep=tDataRepresentation::Deserialized) const
	Creates a static decoder for the given data.
cStaticCodec	MakeStaticCodecFor (void *pData, size_t nDataSize, tDataRepresentation eRep=tDataRepresentation::Deserialized) const
	Creates a static codec for the given data.
cDecoder	MakeDecoderFor (const void *pData, size_t nDataSize, tDataRepresentation eRep=tDataRepresentation::Deserialized) const
	Creates a decoder for the given data.
cCodec	MakeCodecFor (void *pData, size_t nDataSize, tDataRepresentation eRep=tDataRepresentation::Deserialized) const
	Creates a codec for the given data.
size_t	GetStaticElementCount () const
tResult	GetStaticElement (size_t nIndex, const tStructElement *&pElement) const
	Access information about an element.
size_t	GetStaticBufferSize (tDataRepresentation eRep=tDataRepresentation::Deserialized) const

Static Public Member Functions
static const char *	GetStaticStructElementName (const tStructElement *pElement)
	Access information about an element.

Private Attributes
std::shared_ptr< const cStructLayout >	m_pLayout
	For internal use only.
tResult	m_oConstructorResult
	For internal use only.

Detailed Description

Factory class for ddl codecs.

Definition at line 20 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/extern/pkg_ddl/include/adtfddl/codec/codec_factory.h.

Constructor & Destructor Documentation

cCodecFactory() [1/3]

cCodecFactory

(

)

Empty constructor.

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

References cCodecFactory(), and PKG_ADTF_DDL_DEPRECATED.

Referenced by cCodecFactory(), cCodecFactory(), cCodecFactory(), cCodecFactory(), cCodecFactory(), cCodecFactory(), operator=(), and operator=().

cCodecFactory() [2/3]

cCodecFactory	(	const char *	strStructName,
		const char *	strMediaDescription )

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.

References cCodecFactory(), and PKG_ADTF_DDL_DEPRECATED.

cCodecFactory() [3/3]

cCodecFactory

(

const cDDLComplex *

pStruct

)

Constructor that uses an OO-DDL struct for initialization.

Parameters

[in]

pStruct

The struct definition.

References cCodecFactory().

Member Function Documentation

GetStaticBufferSize()

size_t GetStaticBufferSize

(

tDataRepresentation

eRep = 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 GetStaticElement	(	size_t	nIndex,
		const 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 GetStaticElementCount

(

)

const

Returns

The amount of static elements contained in the handled structure.

GetStaticStructElementName()

static const char * GetStaticStructElementName ( const tStructElement * pElement )

static

Access information about an element.

Parameters

[out]

pElement

Pointer that will be updated to point to the element information.

Return values

ERR_INVALID_INDEX

Invalid index.

IsValid()

tResult IsValid

(

)

const

Check if the factory is in a valid state.

Returns

Any errors during construction.

MakeCodecFor()

cCodec MakeCodecFor ( void * pData, size_t nDataSize, tDataRepresentation eRep = tDataRepresentation::Deserialized ) const

inline

Creates a codec for the given data.

Parameters

[in]	pData	The pointer to the raw data.
[in]	nDataSize	The size of the raw data.
[in]	eRep	The representation that the data is encoded in.

Returns

a codec.

Definition at line 122 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/extern/pkg_ddl/include/adtfddl/codec/codec_factory.h.

References m_pLayout.

MakeDecoderFor()

cDecoder MakeDecoderFor ( const void * pData, size_t nDataSize, tDataRepresentation eRep = tDataRepresentation::Deserialized ) const

inline

Creates a decoder for the given data.

Parameters

[in]	pData	The pointer to the raw data.
[in]	nDataSize	The size of the raw data.
[in]	eRep	The representation that the data is encoded in.

Returns

a decoder.

Definition at line 110 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/extern/pkg_ddl/include/adtfddl/codec/codec_factory.h.

References m_pLayout.

MakeStaticCodecFor()

cStaticCodec MakeStaticCodecFor ( void * pData, size_t nDataSize, tDataRepresentation eRep = tDataRepresentation::Deserialized ) const

inline

Creates a static codec for the given data.

Parameters

[in]	pData	The pointer to the raw data.
[in]	nDataSize	The size of the raw data.
[in]	eRep	The representation that the data is encoded in.

Returns

a static codec.

Definition at line 98 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/extern/pkg_ddl/include/adtfddl/codec/codec_factory.h.

References m_pLayout.

MakeStaticDecoderFor()

cStaticDecoder MakeStaticDecoderFor ( const void * pData, size_t nDataSize, tDataRepresentation eRep = tDataRepresentation::Deserialized ) const

inline

Creates a static decoder for the given data.

Parameters

[in]	pData	The pointer to the raw data.
[in]	nDataSize	The size of the raw data.
[in]	eRep	The representation that the data is encoded in.

Returns

a static decoder.

Definition at line 86 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/extern/pkg_ddl/include/adtfddl/codec/codec_factory.h.

References m_pLayout.

Member Data Documentation

m_oConstructorResult

tResult m_oConstructorResult

private

For internal use only.

Definition at line 157 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/extern/pkg_ddl/include/adtfddl/codec/codec_factory.h.

m_pLayout

std::shared_ptr<const cStructLayout> m_pLayout

private

For internal use only.

Definition at line 155 of file builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/extern/pkg_ddl/include/adtfddl/codec/codec_factory.h.

Referenced by MakeCodecFor(), MakeDecoderFor(), MakeStaticCodecFor(), and MakeStaticDecoderFor().