ddl::codec::CodecIndex Class Reference

#include <codec_index.h>

Classes
class	ElementIndex
	The element index at the CodecIndex. More...

Public Member Functions
	CodecIndex ()=default
	Construct a new Codec Index.
const ElementIndex &	operator[] (size_t pos) const
	Access operator to retrieve a elment index on the given pos.
bool	operator== (const CodecIndex &other) const
	Equal operator.
bool	operator!= (const CodecIndex &other) const
	Not equal operator.
size_t	getSize () const
	Get the Size of the codec index in element index count.
size_t	size () const
	Gets the Size of the codec index in element index count for generic programming.
bool	hasLayout () const
	Has layout set.
ElementType	getType () const
	Get the elements type if CodecIndex is valid.
const ElementLayout &	getLayout () const
	Get the Layout.

Friends
class	StructAccess
class	ChildElementAccess
template<typename ElementAccessType, typename ChildElementsType>
class	FactoryElement
template<typename ElementAccessType, typename ChildElementsType>
class	DecoderElement
template<typename ElementAccessType, typename ChildElementsType>
class	CodecElement
template<typename ElementAccessType>
class	ChildElements

Detailed Description

Fast Access Index Type for the coders. The Codec Index ist a vector of element indexes {{[element_index][array_pos]},{[element_sub_index][array_pos]}} pairs to access the elements of one level in a fast way. You can access leafs and elements at each level.

See also

forEachLeafElement, forEachElement, or the getElements() of each codec or decoder.

Member Function Documentation

getLayout()

const ElementLayout & ddl::codec::CodecIndex::getLayout

(

)

const

Get the Layout.

Returns

const ElementLayout&

getSize()

size_t ddl::codec::CodecIndex::getSize

(

)

const

Get the Size of the codec index in element index count.

Returns

size_t

getType()

ElementType ddl::codec::CodecIndex::getType

(

)

const

Get the elements type if CodecIndex is valid.

Returns

ElementType

hasLayout()

bool ddl::codec::CodecIndex::hasLayout

(

)

const

Has layout set.

Returns

true has valid layout set

false has no valid layout set

operator!=()

bool ddl::codec::CodecIndex::operator!=

(

const CodecIndex &

other

)

const

Not equal operator.

Parameters

other

The codec index to compare.

Returns

true if not equal

false if equal

operator==()

bool ddl::codec::CodecIndex::operator==

(

const CodecIndex &

other

)

const

Equal operator.

Parameters

other

The codec index to compare.

Returns

true if equal

false if not equal

operator[]()

const ElementIndex & ddl::codec::CodecIndex::operator[]

(

size_t

pos

)

const

Access operator to retrieve a elment index on the given pos.

Parameters

pos	Position of the element index to retrieve.

Returns

const ElementIndex&

size()

size_t ddl::codec::CodecIndex::size

(

)

const

Gets the Size of the codec index in element index count for generic programming.

Returns

size_t

---

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

• include/ddl/codec/codec_index.h