UN_HandleIterator< HANDLE, GRAPH_DATA, DATA_ID_ITERATOR > Class Template Reference

#include <UN_Iterator.h>

Public Types
using	iterator_category = std::input_iterator_tag
using	value_type = HANDLE
using	difference_type = std::ptrdiff_t
using	pointer = value_type *
using	reference = value_type &

Public Member Functions
	UN_HandleIterator (GRAPH_DATA *graph_data, const DATA_ID_ITERATOR &data_id_iterator)
	Constructor for the start iterator of the given data ID array. More...
UN_HandleIterator &	operator++ ()
	Increment operator. More...
HANDLE	operator* () const
	Dereferencing operator, returns the handle to the current data object. More...
HANDLE	handle () const
	Dereferencing operator, returns the handle to the current data object. More...
bool	operator== (const UN_HandleIterator &other) const
	Comparison operators. More...
bool	operator!= (const UN_HandleIterator &other) const
	Comparison operators. More...

Detailed Description

template<typename HANDLE, typename GRAPH_DATA, typename DATA_ID_ITERATOR>
class UN_HandleIterator< HANDLE, GRAPH_DATA, DATA_ID_ITERATOR >

Iterator for traversing the given data ID array and returning a data handle when the iterator is dereferenced. HANDLE - is a class derived from UN_Handle or UN_ConstHandle GRAPH_DATA is UN_GraphData class, either const or non-const ID_ITERATOR is an underlying iterator to the UN_DataID entries, usually UN_Array<ID>, and can be either forward or backward.

Definition at line 31 of file UN_Iterator.h.

Member Typedef Documentation

template<typename HANDLE , typename GRAPH_DATA , typename DATA_ID_ITERATOR >

using UN_HandleIterator< HANDLE, GRAPH_DATA, DATA_ID_ITERATOR >::difference_type = std::ptrdiff_t

Definition at line 36 of file UN_Iterator.h.

template<typename HANDLE , typename GRAPH_DATA , typename DATA_ID_ITERATOR >

using UN_HandleIterator< HANDLE, GRAPH_DATA, DATA_ID_ITERATOR >::iterator_category = std::input_iterator_tag

Definition at line 34 of file UN_Iterator.h.

template<typename HANDLE , typename GRAPH_DATA , typename DATA_ID_ITERATOR >

using UN_HandleIterator< HANDLE, GRAPH_DATA, DATA_ID_ITERATOR >::pointer = value_type*

Definition at line 37 of file UN_Iterator.h.

template<typename HANDLE , typename GRAPH_DATA , typename DATA_ID_ITERATOR >

using UN_HandleIterator< HANDLE, GRAPH_DATA, DATA_ID_ITERATOR >::reference = value_type&

Definition at line 38 of file UN_Iterator.h.

template<typename HANDLE , typename GRAPH_DATA , typename DATA_ID_ITERATOR >

using UN_HandleIterator< HANDLE, GRAPH_DATA, DATA_ID_ITERATOR >::value_type = HANDLE

Definition at line 35 of file UN_Iterator.h.

Constructor & Destructor Documentation

template<typename HANDLE , typename GRAPH_DATA , typename DATA_ID_ITERATOR >

UN_HandleIterator< HANDLE, GRAPH_DATA, DATA_ID_ITERATOR >::UN_HandleIterator ( GRAPH_DATA *  graph_data, const DATA_ID_ITERATOR &  data_id_iterator  )

inline

Constructor for the start iterator of the given data ID array.

Definition at line 41 of file UN_Iterator.h.

Member Function Documentation

template<typename HANDLE , typename GRAPH_DATA , typename DATA_ID_ITERATOR >

HANDLE UN_HandleIterator< HANDLE, GRAPH_DATA, DATA_ID_ITERATOR >::handle ( ) const

inline

Dereferencing operator, returns the handle to the current data object.

Definition at line 68 of file UN_Iterator.h.

template<typename HANDLE , typename GRAPH_DATA , typename DATA_ID_ITERATOR >

bool UN_HandleIterator< HANDLE, GRAPH_DATA, DATA_ID_ITERATOR >::operator!= ( const UN_HandleIterator< HANDLE, GRAPH_DATA, DATA_ID_ITERATOR > &  other ) const

inline

Comparison operators.

Definition at line 50 of file UN_Iterator.h.

template<typename HANDLE , typename GRAPH_DATA , typename DATA_ID_ITERATOR >

HANDLE UN_HandleIterator< HANDLE, GRAPH_DATA, DATA_ID_ITERATOR >::operator* ( ) const

inline

Dereferencing operator, returns the handle to the current data object.

Definition at line 62 of file UN_Iterator.h.

template<typename HANDLE , typename GRAPH_DATA , typename DATA_ID_ITERATOR >

UN_HandleIterator& UN_HandleIterator< HANDLE, GRAPH_DATA, DATA_ID_ITERATOR >::operator++ ( )

inline

Increment operator.

Definition at line 55 of file UN_Iterator.h.

template<typename HANDLE , typename GRAPH_DATA , typename DATA_ID_ITERATOR >

bool UN_HandleIterator< HANDLE, GRAPH_DATA, DATA_ID_ITERATOR >::operator== ( const UN_HandleIterator< HANDLE, GRAPH_DATA, DATA_ID_ITERATOR > &  other ) const

inline

Comparison operators.

Definition at line 48 of file UN_Iterator.h.

---

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

• UN/UN_Iterator.h