ddl::CodecFactory Class Reference

#include <codec_factory_legacy.h>

Public Member Functions
DEV_ESSENTIAL_DEPRECATED_CODEC_FACTORY	CodecFactory ()
DEV_ESSENTIAL_DEPRECATED_CODEC_FACTORY	CodecFactory (const std::string &struct_name, const std::string &dd_string)
DEV_ESSENTIAL_DEPRECATED_CODEC_FACTORY	CodecFactory (const ddl::dd::StructType &struct_type, const dd::DataDefinition &dd)
DEV_ESSENTIAL_DEPRECATED_CODEC_FACTORY	CodecFactory (const ddl::dd::StructTypeAccess &struct_type_access)
DEV_ESSENTIAL_DEPRECATED_CODEC_FACTORY	CodecFactory (const DDStructure &dd_struct)
a_util::result::Result	isValid () const
StaticDecoder	makeStaticDecoderFor (const void *data, size_t data_size, DataRepresentation rep=deserialized) const
StaticCodec	makeStaticCodecFor (void *data, size_t data_size, DataRepresentation rep=deserialized) const
Decoder	makeDecoderFor (const void *data, size_t data_size, DataRepresentation rep=deserialized) const
Codec	makeCodecFor (void *data, size_t data_size, DataRepresentation rep=deserialized) const
size_t	getStaticElementCount () const
a_util::result::Result	getStaticElement (size_t index, const StructElement *&element) const
size_t	getStaticBufferSize (DataRepresentation rep=deserialized) const

Detailed Description

Factory class for ddl codecs.

Deprecated

Use the new ddl::codec::CodecFactory() instead.

Constructor & Destructor Documentation

CodecFactory() [1/5]

DEV_ESSENTIAL_DEPRECATED_CODEC_FACTORY ddl::CodecFactory::CodecFactory

(

)

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

CodecFactory() [2/5]

DEV_ESSENTIAL_DEPRECATED_CODEC_FACTORY ddl::CodecFactory::CodecFactory	(	const std::string &	struct_name,
		const std::string &	dd_string )

Constructor that take a DataDefinition string for initialization.

Parameters

[in]	struct_name	The name of the struct for which codecs should be generated.
[in]	dd_string	The DataDefinition description within a (xml)string.

CodecFactory() [3/5]

DEV_ESSENTIAL_DEPRECATED_CODEC_FACTORY ddl::CodecFactory::CodecFactory	(	const ddl::dd::StructType &	struct_type,
		const dd::DataDefinition &	dd )

Constructor that uses an OO-DataDefinition struct for initialization.

Parameters

[in]	struct_type	The struct definition.
[in]	dd	The DD

CodecFactory() [4/5]

DEV_ESSENTIAL_DEPRECATED_CODEC_FACTORY ddl::CodecFactory::CodecFactory

(

const ddl::dd::StructTypeAccess &

struct_type_access

)

Constructor that uses an valid struct type access for initialization.

Parameters

[in]

struct_type_access

The struct type access.

CodecFactory() [5/5]

DEV_ESSENTIAL_DEPRECATED_CODEC_FACTORY ddl::CodecFactory::CodecFactory

(

const DDStructure &

dd_struct

)

Constructor that uses an OO-DataDefinition struct for initialization.

Parameters

[in]

dd_struct

The struct definition.

Member Function Documentation

getStaticBufferSize()

size_t ddl::CodecFactory::getStaticBufferSize

(

DataRepresentation

rep = deserialized

)

const

Parameters

[in]

rep

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

Returns

The size of the structure in the requested data representation.

getStaticElement()

a_util::result::Result ddl::CodecFactory::getStaticElement	(	size_t	index,
		const StructElement *&	element ) const

Access information about an element.

Parameters

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

Return values

ERR_INVALID_INDEX

Invalid index.

getStaticElementCount()

size_t ddl::CodecFactory::getStaticElementCount

(

)

const

Returns

The amount of static elements contained in the handled structure.

isValid()

a_util::result::Result ddl::CodecFactory::isValid

(

)

const

Check if the factory is in a valid state.

Returns

Any errors during construction.

makeCodecFor()

Codec ddl::CodecFactory::makeCodecFor ( void * data, size_t data_size, DataRepresentation rep = deserialized ) const

inline

Creates a codec for the given data.

Parameters

[in]	data	The pointer to the raw data.
[in]	data_size	The size of the raw data.
[in]	rep	The representation that the data is encoded in.

Returns

a codec.

makeDecoderFor()

Decoder ddl::CodecFactory::makeDecoderFor ( const void * data, size_t data_size, DataRepresentation rep = deserialized ) const

inline

Creates a decoder for the given data.

Parameters

[in]	data	The pointer to the raw data.
[in]	data_size	The size of the raw data.
[in]	rep	The representation that the data is encoded in.

Returns

a decoder.

makeStaticCodecFor()

StaticCodec ddl::CodecFactory::makeStaticCodecFor ( void * data, size_t data_size, DataRepresentation rep = deserialized ) const

inline

Creates a static codec for the given data.

Parameters

[in]	data	The pointer to the raw data.
[in]	data_size	The size of the raw data.
[in]	rep	The representation that the data is encoded in.

Returns

a static codec.

makeStaticDecoderFor()

StaticDecoder ddl::CodecFactory::makeStaticDecoderFor ( const void * data, size_t data_size, DataRepresentation rep = deserialized ) const

inline

Creates a static decoder for the given data.

Parameters

[in]	data	The pointer to the raw data.
[in]	data_size	The size of the raw data.
[in]	rep	The representation that the data is encoded in.

Returns

a static decoder.

---

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

• /workspace/conan/dev_essential/1.6.3/dw/stable/package/65324bff46e457721a7ba250afe9d61dc2b0e57a/include/ddl/codec/legacy/codec_factory_legacy.h