UN_DataArrayIterator< HANDLE, ID_ARRAY > 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_DataArrayIterator (UN_GraphData *graph_data, ID_ARRAY &&data_ids, exint begin=0)
	Constructor for the start iterator of the given data array. More...
	UN_DataArrayIterator (UN_GraphData *graph_data, exint end)
	Constructor for the end iterator. More...
UN_DataArrayIterator &	operator++ ()
	Increment operator. More...
bool	operator!= (const UN_DataArrayIterator &other) const
	Comparison operator. More...
HANDLE	operator* () const
	Dereferencing operator, returns the handle to the current data object. More...
HANDLE	handle () const
	Returns the handle to the current data object. More...

Detailed Description

template<typename HANDLE, typename ID_ARRAY>
class UN_DataArrayIterator< HANDLE, ID_ARRAY >

Iterator for traversing the given data ID array. The iterator dereferences as a handle to the data object. Used for iterating children of a node, parameters of a node, etc.

Definition at line 33 of file UN_Iterator.h.

Member Typedef Documentation

template<typename HANDLE, typename ID_ARRAY>

using UN_DataArrayIterator< HANDLE, ID_ARRAY >::difference_type = std::ptrdiff_t

Definition at line 38 of file UN_Iterator.h.

template<typename HANDLE, typename ID_ARRAY>

using UN_DataArrayIterator< HANDLE, ID_ARRAY >::iterator_category = std::input_iterator_tag

Definition at line 36 of file UN_Iterator.h.

template<typename HANDLE, typename ID_ARRAY>

using UN_DataArrayIterator< HANDLE, ID_ARRAY >::pointer = value_type*

Definition at line 39 of file UN_Iterator.h.

template<typename HANDLE, typename ID_ARRAY>

using UN_DataArrayIterator< HANDLE, ID_ARRAY >::reference = value_type&

Definition at line 40 of file UN_Iterator.h.

template<typename HANDLE, typename ID_ARRAY>

using UN_DataArrayIterator< HANDLE, ID_ARRAY >::value_type = HANDLE

Definition at line 37 of file UN_Iterator.h.

Constructor & Destructor Documentation

template<typename HANDLE, typename ID_ARRAY>

UN_DataArrayIterator< HANDLE, ID_ARRAY >::UN_DataArrayIterator ( UN_GraphData *  graph_data, ID_ARRAY &&  data_ids, exint  begin = 0  )

inline

Constructor for the start iterator of the given data array.

Definition at line 43 of file UN_Iterator.h.

template<typename HANDLE, typename ID_ARRAY>

UN_DataArrayIterator< HANDLE, ID_ARRAY >::UN_DataArrayIterator ( UN_GraphData *  graph_data, exint  end  )

inline

Constructor for the end iterator.

Definition at line 52 of file UN_Iterator.h.

Member Function Documentation

template<typename HANDLE, typename ID_ARRAY>

HANDLE UN_DataArrayIterator< HANDLE, ID_ARRAY >::handle ( ) const

inline

Returns the handle to the current data object.

Definition at line 78 of file UN_Iterator.h.

template<typename HANDLE, typename ID_ARRAY>

bool UN_DataArrayIterator< HANDLE, ID_ARRAY >::operator!= ( const UN_DataArrayIterator< HANDLE, ID_ARRAY > &  other ) const

inline

Comparison operator.

Definition at line 65 of file UN_Iterator.h.

template<typename HANDLE, typename ID_ARRAY>

HANDLE UN_DataArrayIterator< HANDLE, ID_ARRAY >::operator* ( ) const

inline

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

Definition at line 72 of file UN_Iterator.h.

template<typename HANDLE, typename ID_ARRAY>

UN_DataArrayIterator& UN_DataArrayIterator< HANDLE, ID_ARRAY >::operator++ ( )

inline

Increment operator.

Definition at line 58 of file UN_Iterator.h.

---

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

• UN/UN_Iterator.h