The Leaf codec index is a small layout information index to access the decoders/codecs data very fast. There are following constraints: More...

Public Member Functions
	LeafCodecIndex ()=delete
	no CTOR

	LeafCodecIndex (const CodecIndex &codec_index, ddl::DataRepresentation rep)
	CTOR.

const LeafLayout &	getLayout () const noexcept
	Get the leaf layout.

Static Public Member Functions
template<bool ThrowError>
static bool	convertToLeafLayout (const CodecIndex &codec_index, LeafLayout &leaf_layout, ddl::DataRepresentation rep)
	Retrieves a valid, small, 8-bytes LeafLayout from a CodecIndex.

Detailed Description

The Leaf codec index is a small layout information index to access the decoders/codecs data very fast. There are following constraints:

only possible to retrieve layout information for a leaf within the struct
only standard data types are supported
no customized data type can be used (standard must have standard sizes, user types are not possible)
with this index it is not possible to identify the name of the element
no complex types or the whole array element can be accessed
it can only describe serialized or deserialized data representation, you need to set while creating it

Constructor & Destructor Documentation

ddl::codec::LeafCodecIndex::LeafCodecIndex	(	const CodecIndex &	codec_index,
		ddl::DataRepresentation	rep )

inline

CTOR.

Parameters

codec_index	the valid codec index to create the LeafCodecIndex from
rep	the data representation to extract for decoding

template<bool ThrowError>

static bool ddl::codec::LeafCodecIndex::convertToLeafLayout	(	const CodecIndex &	codec_index,
		LeafLayout &	leaf_layout,
		ddl::DataRepresentation	rep )

inlinestatic

Retrieves a valid, small, 8-bytes LeafLayout from a CodecIndex.

Template Parameters

ThrowError Throws if the conversion is not possible. (If set to false, the return value must be checked!)

Parameters

codec_index	The CodecIndex to retrieve the layout information from
leaf_layout	The new small leaf layout
rep	The layout information for a serialzed or deserialized representation

Returns: true The layout retrieval was successfully; false The layout retrieval was not successfully

const LeafLayout & ddl::codec::LeafCodecIndex::getLayout ( ) const

inlinenoexcept

Get the leaf layout.

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/leaf_value_access.h