UN_NodeUtils::DescendantNodeIterator Class Reference

#include <UN_NodeUtils.h>

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

Public Member Functions
	DescendantNodeIterator (const UN_GraphData *graph_data, UN_NodeID node_id)
	Constructor for the start iterator of the given node ancestral tree. More...
	DescendantNodeIterator (const UN_GraphData *graph_data)
	Constructor for the end iterator. More...
DescendantNodeIterator &	operator++ ()
	Increment operator. More...
UN_NodeID	operator* () const
	Returns the ID of the current node. More...
const UN_GraphData *	graph () const
	Returns the underlying graph in which the current node exists. More...
bool	operator== (const DescendantNodeIterator &other) const
	Comparison operators. More...
bool	operator!= (const DescendantNodeIterator &other) const
	Comparison operators. More...

Detailed Description

An iterator for traversing the descendant nodes (children, grandchildren, etc) of a given ancestor node.

Definition at line 671 of file UN_NodeUtils.h.

Member Typedef Documentation

using UN_NodeUtils::DescendantNodeIterator::difference_type = std::ptrdiff_t

Definition at line 676 of file UN_NodeUtils.h.

using UN_NodeUtils::DescendantNodeIterator::iterator_category = std::input_iterator_tag

Definition at line 674 of file UN_NodeUtils.h.

using UN_NodeUtils::DescendantNodeIterator::pointer = value_type*

Definition at line 677 of file UN_NodeUtils.h.

using UN_NodeUtils::DescendantNodeIterator::reference = value_type&

Definition at line 678 of file UN_NodeUtils.h.

using UN_NodeUtils::DescendantNodeIterator::value_type = UN_NodeID

Definition at line 675 of file UN_NodeUtils.h.

Constructor & Destructor Documentation

UN_NodeUtils::DescendantNodeIterator::DescendantNodeIterator ( const UN_GraphData *  graph_data, UN_NodeID  node_id  )

inline

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

Definition at line 681 of file UN_NodeUtils.h.

UN_NodeUtils::DescendantNodeIterator::DescendantNodeIterator ( const UN_GraphData *  graph_data )

inline

Constructor for the end iterator.

Definition at line 688 of file UN_NodeUtils.h.

Member Function Documentation

const UN_GraphData* UN_NodeUtils::DescendantNodeIterator::graph ( ) const

inline

Returns the underlying graph in which the current node exists.

Definition at line 723 of file UN_NodeUtils.h.

bool UN_NodeUtils::DescendantNodeIterator::operator!= ( const DescendantNodeIterator &  other ) const

inline

Comparison operators.

Definition at line 701 of file UN_NodeUtils.h.

UN_NodeID UN_NodeUtils::DescendantNodeIterator::operator* ( ) const

inline

Returns the ID of the current node.

Definition at line 717 of file UN_NodeUtils.h.

DescendantNodeIterator& UN_NodeUtils::DescendantNodeIterator::operator++ ( )

inline

Increment operator.

Definition at line 708 of file UN_NodeUtils.h.

bool UN_NodeUtils::DescendantNodeIterator::operator== ( const DescendantNodeIterator &  other ) const

inline

Comparison operators.

Definition at line 693 of file UN_NodeUtils.h.

---

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

• UN/UN_NodeUtils.h