UN_NodeDescendantIterator Class Reference

#include <UN_Iterator.h>

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

Public Member Functions
	UN_NodeDescendantIterator (UN_GraphData *graph_data, UN_NodeIndex node_index, UN_NodeID node_id)
	Constructor for the start iterator of the given node ancestral tree. More...
	UN_NodeDescendantIterator (UN_GraphData *graph_data)
	Constructor for the end iterator. More...
UN_NodeDescendantIterator &	operator++ ()
	Increment operator. More...
bool	operator!= (const UN_NodeDescendantIterator &other) const
	Comparison operator. More...
UN_Node	operator* () const
	Dereferencing operator, returns the handle to the current node data obj. More...

Detailed Description

Iterator for traversing the node data objects that are arranged in a parental tree hierarchy. The iterator dereferences as a handle to node data object. Used for iterating connected nodes in nested subnetworks.

Definition at line 150 of file UN_Iterator.h.

Member Typedef Documentation

using UN_NodeDescendantIterator::difference_type = std::ptrdiff_t

Definition at line 155 of file UN_Iterator.h.

using UN_NodeDescendantIterator::iterator_category = std::input_iterator_tag

Definition at line 153 of file UN_Iterator.h.

using UN_NodeDescendantIterator::pointer = value_type*

Definition at line 156 of file UN_Iterator.h.

using UN_NodeDescendantIterator::reference = value_type&

Definition at line 157 of file UN_Iterator.h.

using UN_NodeDescendantIterator::value_type = UN_Node

Definition at line 154 of file UN_Iterator.h.

Constructor & Destructor Documentation

UN_NodeDescendantIterator::UN_NodeDescendantIterator ( UN_GraphData *  graph_data, UN_NodeIndex  node_index, UN_NodeID  node_id  )

inline

Constructor for the start iterator of the given node ancestral tree.

Definition at line 160 of file UN_Iterator.h.

UN_NodeDescendantIterator::UN_NodeDescendantIterator ( UN_GraphData *  graph_data )

inline

Constructor for the end iterator.

Definition at line 169 of file UN_Iterator.h.

Member Function Documentation

bool UN_NodeDescendantIterator::operator!= ( const UN_NodeDescendantIterator &  other ) const

inline

Comparison operator.

Definition at line 185 of file UN_Iterator.h.

UN_Node UN_NodeDescendantIterator::operator*

(

)

const

Dereferencing operator, returns the handle to the current node data obj.

UN_NodeDescendantIterator& UN_NodeDescendantIterator::operator++ ( )

inline

Increment operator.

Definition at line 174 of file UN_Iterator.h.

---

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

• UN/UN_Iterator.h