UN_NodeUtils::DescendantWireIterator Class Reference

An iterator for traversing the wires deep inside the given node. More...

#include <UN_NodeUtils.h>

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

Public Member Functions
	DescendantWireIterator (const UN_GraphData *graph_data, UN_NodeID node_id)
	Constructor for the start and end iterator for node's wires. More...
	DescendantWireIterator (const UN_GraphData *graph_data)
	Constructor for the end iterator. More...
DescendantWireIterator &	operator++ ()
	Increment operator. More...
UN_WireID	operator* () const
	Returns the ID of the current wire. More...
const UN_GraphData *	graph () const
	Returns the underlying graph in which the current node exists. More...
bool	operator== (const DescendantWireIterator &other) const
	Comparison operators. More...
bool	operator!= (const DescendantWireIterator &other) const
	Comparison operators. More...

Detailed Description

An iterator for traversing the wires deep inside the given node.

Definition at line 861 of file UN_NodeUtils.h.

Member Typedef Documentation

using UN_NodeUtils::DescendantWireIterator::difference_type = std::ptrdiff_t

Definition at line 866 of file UN_NodeUtils.h.

using UN_NodeUtils::DescendantWireIterator::iterator_category = std::input_iterator_tag

Definition at line 864 of file UN_NodeUtils.h.

using UN_NodeUtils::DescendantWireIterator::pointer = value_type*

Definition at line 867 of file UN_NodeUtils.h.

using UN_NodeUtils::DescendantWireIterator::reference = value_type&

Definition at line 868 of file UN_NodeUtils.h.

using UN_NodeUtils::DescendantWireIterator::value_type = UN_WireID

Definition at line 865 of file UN_NodeUtils.h.

Constructor & Destructor Documentation

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

inline

Constructor for the start and end iterator for node's wires.

Definition at line 871 of file UN_NodeUtils.h.

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

inline

Constructor for the end iterator.

Definition at line 879 of file UN_NodeUtils.h.

Member Function Documentation

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

inline

Returns the underlying graph in which the current node exists.

Definition at line 913 of file UN_NodeUtils.h.

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

inline

Comparison operators.

Definition at line 900 of file UN_NodeUtils.h.

UN_WireID UN_NodeUtils::DescendantWireIterator::operator* ( ) const

inline

Returns the ID of the current wire.

Definition at line 907 of file UN_NodeUtils.h.

DescendantWireIterator& UN_NodeUtils::DescendantWireIterator::operator++ ( )

inline

Increment operator.

Definition at line 885 of file UN_NodeUtils.h.

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

inline

Comparison operators.

Definition at line 892 of file UN_NodeUtils.h.

---

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

• UN/UN_NodeUtils.h