UN_PortUtils::PortIterator< IS_SOURCE_ITERATOR > Class Template Reference

#include <UN_PortUtils.h>

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

Public Member Functions
	PortIterator (const UN_GraphData *graph_data, const UN_WireIDList::const_iterator &wire_id_iterator)
	Constructor for the start iterator. More...
bool	operator== (const PortIterator &other) const
	Equality comparison operator. More...
bool	operator!= (const PortIterator &other) const
	Inequality comparison operator. More...
PortIterator &	operator++ ()
	Increment operator. More...
UN_PortID	operator* () const
	Returns the current port ID. More...
const UN_GraphData *	graph () const
	Returns the underlying graph in which the current node exists. More...

Detailed Description

template<bool IS_SOURCE_ITERATOR>
class UN_PortUtils::PortIterator< IS_SOURCE_ITERATOR >

An iterator for traversing the ports connected to the given port. NOTE, it holds a reference to the given wires array, and therefore node ports can't be safely added/removed during the iteration.

Definition at line 278 of file UN_PortUtils.h.

Member Typedef Documentation

template<bool IS_SOURCE_ITERATOR>

using UN_PortUtils::PortIterator< IS_SOURCE_ITERATOR >::difference_type = std::ptrdiff_t

Definition at line 283 of file UN_PortUtils.h.

template<bool IS_SOURCE_ITERATOR>

using UN_PortUtils::PortIterator< IS_SOURCE_ITERATOR >::iterator_category = std::input_iterator_tag

Definition at line 281 of file UN_PortUtils.h.

template<bool IS_SOURCE_ITERATOR>

using UN_PortUtils::PortIterator< IS_SOURCE_ITERATOR >::pointer = value_type*

Definition at line 284 of file UN_PortUtils.h.

template<bool IS_SOURCE_ITERATOR>

using UN_PortUtils::PortIterator< IS_SOURCE_ITERATOR >::reference = value_type&

Definition at line 285 of file UN_PortUtils.h.

template<bool IS_SOURCE_ITERATOR>

using UN_PortUtils::PortIterator< IS_SOURCE_ITERATOR >::value_type = UN_PortID

Definition at line 282 of file UN_PortUtils.h.

Constructor & Destructor Documentation

template<bool IS_SOURCE_ITERATOR>

UN_PortUtils::PortIterator< IS_SOURCE_ITERATOR >::PortIterator ( const UN_GraphData *  graph_data, const UN_WireIDList::const_iterator &  wire_id_iterator  )

inline

Constructor for the start iterator.

Definition at line 288 of file UN_PortUtils.h.

Member Function Documentation

template<bool IS_SOURCE_ITERATOR>

const UN_GraphData* UN_PortUtils::PortIterator< IS_SOURCE_ITERATOR >::graph ( ) const

inline

Returns the underlying graph in which the current node exists.

Definition at line 326 of file UN_PortUtils.h.

template<bool IS_SOURCE_ITERATOR>

bool UN_PortUtils::PortIterator< IS_SOURCE_ITERATOR >::operator!= ( const PortIterator< IS_SOURCE_ITERATOR > &  other ) const

inline

Inequality comparison operator.

Definition at line 302 of file UN_PortUtils.h.

template<bool IS_SOURCE_ITERATOR>

UN_PortID UN_PortUtils::PortIterator< IS_SOURCE_ITERATOR >::operator* ( ) const

inline

Returns the current port ID.

Definition at line 315 of file UN_PortUtils.h.

template<bool IS_SOURCE_ITERATOR>

PortIterator& UN_PortUtils::PortIterator< IS_SOURCE_ITERATOR >::operator++ ( )

inline

Increment operator.

Definition at line 308 of file UN_PortUtils.h.

template<bool IS_SOURCE_ITERATOR>

bool UN_PortUtils::PortIterator< IS_SOURCE_ITERATOR >::operator== ( const PortIterator< IS_SOURCE_ITERATOR > &  other ) const

inline

Equality comparison operator.

Definition at line 295 of file UN_PortUtils.h.

---

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

• UN/UN_PortUtils.h