ddl::codec::CodecIndex::ElementIndex Class Reference

The element index at the CodecIndex. More...

#include <codec_index.h>

Public Member Functions
	ElementIndex ()=default
	CTOR.
	ElementIndex (size_t element_index)
	CTOR.
	ElementIndex (size_t element_index, size_t array_pos)
	CTOR.
bool	operator== (const ElementIndex &other) const
	equal operator.
bool	operator!= (const ElementIndex &other) const
	Not equal operator.
size_t	getIndex () const
	Get the Index.
size_t	getArrayPos () const
	Get the Array Pos.
ElementIndex &	operator++ ()
	Incrememts the index, keeps array pos.

Static Public Attributes
static constexpr size_t	_invalid_element_index = static_cast<size_t>(-1)
	Invalid element index.
static constexpr size_t	_invalid_array_pos = static_cast<size_t>(-1)
	Invalid array pos.

Detailed Description

The element index at the CodecIndex.

Constructor & Destructor Documentation

ElementIndex() [1/2]

ddl::codec::CodecIndex::ElementIndex::ElementIndex

(

size_t

element_index

)

CTOR.

Parameters

element_index

The index to set, array_pos 0 is forced

ElementIndex() [2/2]

ddl::codec::CodecIndex::ElementIndex::ElementIndex	(	size_t	element_index,
		size_t	array_pos )

CTOR.

Parameters

element_index	The index to set
array_pos	The array_pos to set

Member Function Documentation

getArrayPos()

size_t ddl::codec::CodecIndex::ElementIndex::getArrayPos

(

)

const

Get the Array Pos.

Returns

size_t

getIndex()

size_t ddl::codec::CodecIndex::ElementIndex::getIndex

(

)

const

Get the Index.

Returns

size_t

operator!=()

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

(

const ElementIndex &

other

)

const

Not equal operator.

Parameters

other

The element index to compare.

Returns

true if not equal

false if equal

operator++()

ElementIndex & ddl::codec::CodecIndex::ElementIndex::operator++

(

)

Incrememts the index, keeps array pos.

Returns

ElementIndex&

operator==()

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

(

const ElementIndex &

other

)

const

equal operator.

Parameters

other

The element index to compare.

Returns

true if equal

false if not equal

---

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