CodecIndex

Fast Access Index Type for the coders. More...

#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.

Private Member Functions
	CodecIndex (const CodecIndex &codec_index, ElementIndex index)
	CodecIndex (ElementIndex index)
	CodecIndex (const CodecIndex &codec_index, size_t count, ElementIndex index)
	CodecIndex (const std::vector< ElementIndex > &indexes)
	CodecIndex (ElementIndex index, const ElementLayout &layout)
	CodecIndex (const CodecIndex &codec_index, size_t count, ElementIndex index, const ElementLayout &layout)
CodecIndex &	operator++ ()
CodecIndex	operator++ (int)
void	setLayout (const ElementLayout &layout)
void	addElementIndex (ElementIndex index)
CodecIndex::ElementIndex	back () const noexcept
CodecIndex	getIndexForArrayPos (size_t array_pos) const

Private Attributes
std::vector< ElementIndex >	_indices = {}
ElementLayout	_layout = {}
bool	_layout_valid = {}

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.

Definition at line 132 of file codec_index.h.

Member Function Documentation

getLayout()

const ElementLayout & getLayout

(

)

const

Get the Layout.

Returns

const ElementLayout&

References CodecIndex().

Referenced by CodecElement< CodecElementAccess< Codec > >::reset().

getSize()

size_t getSize

(

)

const

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

Returns

size_t

getType()

ElementType getType

(

)

const

Get the elements type if CodecIndex is valid.

Returns

ElementType

Referenced by LeafCodecIndex::checkLeafLayout(), and adtf::mediadescription::osborn::get_value_as_variant().

hasLayout()

bool hasLayout

(

)

const

Has layout set.

Returns

true has valid layout set

false has no valid layout set

operator!=()

bool operator!=

(

const CodecIndex &

other

)

const

Not equal operator.

Parameters

other

The codec index to compare.

Returns

true if not equal

false if equal

References CodecIndex().

operator==()

bool operator==

(

const CodecIndex &

other

)

const

Equal operator.

Parameters

other

The codec index to compare.

Returns

true if equal

false if not equal

References CodecIndex().

operator[]()

const ElementIndex & 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 size

(

)

const

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

Returns

size_t

Member Data Documentation

_indices

std::vector<ElementIndex> _indices = {}

private

Definition at line 297 of file codec_index.h.

_layout

ElementLayout _layout = {}

private

Definition at line 298 of file codec_index.h.

_layout_valid

bool _layout_valid = {}

private

Definition at line 299 of file codec_index.h.