Kanzi 4.1.0
Public Member Functions | Protected Attributes | List of all members
kanzi::indexed_list< T >::element_type Class Reference

Value type for internal container. More...

#include <kanzi/core/cpp/indexed_list.hpp>

Public Member Functions

 element_type (const element_type &other)=default
 Default copy constructor.
 
 element_type (const T &value, size_t prevIndex, size_t indexInSortingOrder)
 Constructor.
 
 element_type (const T &value, size_t prevIndex, size_t nextIndex, size_t indexInSortingOrder)
 Constructor.
 
 element_type (element_type &&other)=default
 Default move constructor.
 
 element_type (T &&value, size_t prevIndex, size_t indexInSortingOrder)
 Constructor.
 
 element_type (T &&value, size_t prevIndex, size_t nextIndex, size_t indexInSortingOrder)
 Constructor.
 
size_t getIndexInSortedOrder () const
 Gets the index in sorting list.
 
size_t getNextIndex () const
 Gets the next index.
 
size_t getPrevIndex () const
 Gets the previous index.
 
T & operator* ()
 Dereference operator.
 
const T & operator* () const
 Const dereference operator.
 
element_type & operator= (const element_type &other)=default
 Default copy operator.
 
element_type & operator= (element_type &&other)=default
 Default move operator.
 
void setIndexInSortedOrder (size_t indexInSortedOrder)
 Sets the index in sorting list.
 
void setNextIndex (size_t nextIndex)
 Sets the next index.
 
void setPrevIndex (size_t prevIndex)
 Sets the previous index.
 

Protected Attributes

size_t m_indexInSortedOrder
 Index where this element is referred to in the sorting list.
 
size_t m_nextIndex
 Next element (index).
 
size_t m_prevIndex
 Previous element (index).
 
T m_value
 Contained value.
 

Detailed Description

template<typename T>
class kanzi::indexed_list< T >::element_type

Value type for internal container.

Constructor & Destructor Documentation

◆ element_type() [1/6]

template<typename T >
kanzi::indexed_list< T >::element_type::element_type ( const T & value,
size_t prevIndex,
size_t indexInSortingOrder )
inline

Constructor.

Next index is initialized at invalid.

Parameters
valueValue to contain.
prevIndexPrevious index.
indexInSortingOrderIndex in the sorting with reference to this item.

◆ element_type() [2/6]

template<typename T >
kanzi::indexed_list< T >::element_type::element_type ( T && value,
size_t prevIndex,
size_t indexInSortingOrder )
inline

Constructor.

Next index is initialized at invalid.

Parameters
valueValue to contain.
prevIndexPrevious index.
indexInSortingOrderIndex in the sorting with reference to this item.

◆ element_type() [3/6]

template<typename T >
kanzi::indexed_list< T >::element_type::element_type ( const T & value,
size_t prevIndex,
size_t nextIndex,
size_t indexInSortingOrder )
inline

Constructor.

Parameters
valueValue to contain.
prevIndexPrevious index.
nextIndexNext index.
indexInSortingOrderIndex in the sorting with reference to this item.

◆ element_type() [4/6]

template<typename T >
kanzi::indexed_list< T >::element_type::element_type ( T && value,
size_t prevIndex,
size_t nextIndex,
size_t indexInSortingOrder )
inline

Constructor.

Parameters
valueValue to contain.
prevIndexPrevious index.
nextIndexNext index.
indexInSortingOrderIndex in the sorting with reference to this item.

◆ element_type() [5/6]

template<typename T >
kanzi::indexed_list< T >::element_type::element_type ( const element_type & other)
default

Default copy constructor.

Parameters
otherSource element.

◆ element_type() [6/6]

template<typename T >
kanzi::indexed_list< T >::element_type::element_type ( element_type && other)
default

Default move constructor.

Parameters
otherSource element.

Member Function Documentation

◆ operator=() [1/2]

template<typename T >
element_type & kanzi::indexed_list< T >::element_type::operator= ( const element_type & other)
default

Default copy operator.

Parameters
otherSource element.
Returns
This element.

◆ operator=() [2/2]

template<typename T >
element_type & kanzi::indexed_list< T >::element_type::operator= ( element_type && other)
default

Default move operator.

Parameters
otherSource element.
Returns
This element.

◆ getPrevIndex()

template<typename T >
size_t kanzi::indexed_list< T >::element_type::getPrevIndex ( ) const
inline

Gets the previous index.

Returns
Previous index.

◆ setPrevIndex()

template<typename T >
void kanzi::indexed_list< T >::element_type::setPrevIndex ( size_t prevIndex)
inline

Sets the previous index.

Parameters
prevIndexPrevious index for the element.

◆ getNextIndex()

template<typename T >
size_t kanzi::indexed_list< T >::element_type::getNextIndex ( ) const
inline

Gets the next index.

Returns
Next index.

◆ setNextIndex()

template<typename T >
void kanzi::indexed_list< T >::element_type::setNextIndex ( size_t nextIndex)
inline

Sets the next index.

Parameters
nextIndexNext index for the element.

◆ getIndexInSortedOrder()

template<typename T >
size_t kanzi::indexed_list< T >::element_type::getIndexInSortedOrder ( ) const
inline

Gets the index in sorting list.

Returns
Index in the sorting list.

◆ setIndexInSortedOrder()

template<typename T >
void kanzi::indexed_list< T >::element_type::setIndexInSortedOrder ( size_t indexInSortedOrder)
inline

Sets the index in sorting list.

Parameters
indexInSortedOrderNew index in the sorting array.

◆ operator*() [1/2]

template<typename T >
T & kanzi::indexed_list< T >::element_type::operator* ( )
inline

Dereference operator.

Returns
Reference to contained value.

◆ operator*() [2/2]

template<typename T >
const T & kanzi::indexed_list< T >::element_type::operator* ( ) const
inline

Const dereference operator.

Returns
Const reference to contained value.

Member Data Documentation

◆ m_value

template<typename T >
T kanzi::indexed_list< T >::element_type::m_value
protected

Contained value.

◆ m_prevIndex

template<typename T >
size_t kanzi::indexed_list< T >::element_type::m_prevIndex
protected

Previous element (index).

◆ m_nextIndex

template<typename T >
size_t kanzi::indexed_list< T >::element_type::m_nextIndex
protected

Next element (index).

◆ m_indexInSortedOrder

template<typename T >
size_t kanzi::indexed_list< T >::element_type::m_indexInSortedOrder
protected

Index where this element is referred to in the sorting list.

Required for maintaining state without lookup from the sorting list.

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