UN_NodeWireIterator< CHILD_ONLY > Class Template Reference

#include <UN_Iterator.h>

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

Public Member Functions
	UN_NodeWireIterator (UN_GraphData *graph_data, UN_NodeID node_id)
	Constructor for the start and end iterator for node's wires. More...
	UN_NodeWireIterator (UN_GraphData *graph_data)
	Constructor for the end iterator. More...
UN_NodeWireIterator &	operator++ ()
	Increment operator. More...
bool	operator!= (const UN_NodeWireIterator &other) const
	Comparison operator. More...
UN_Wire	operator* () const
	Dereferencing operator, returns the handle to the wire inside the node. More...

Detailed Description

template<bool CHILD_ONLY>
class UN_NodeWireIterator< CHILD_ONLY >

Iterator for traversing the wires inside the given node. The iterator dereferences as a handle to the wire data object. Used for iterating wires inside a node.

Definition at line 206 of file UN_Iterator.h.

Member Typedef Documentation

template<bool CHILD_ONLY>

using UN_NodeWireIterator< CHILD_ONLY >::difference_type = std::ptrdiff_t

Definition at line 211 of file UN_Iterator.h.

template<bool CHILD_ONLY>

using UN_NodeWireIterator< CHILD_ONLY >::iterator_category = std::input_iterator_tag

Definition at line 209 of file UN_Iterator.h.

template<bool CHILD_ONLY>

using UN_NodeWireIterator< CHILD_ONLY >::pointer = value_type*

Definition at line 212 of file UN_Iterator.h.

template<bool CHILD_ONLY>

using UN_NodeWireIterator< CHILD_ONLY >::reference = value_type&

Definition at line 213 of file UN_Iterator.h.

template<bool CHILD_ONLY>

using UN_NodeWireIterator< CHILD_ONLY >::value_type = UN_Wire

Definition at line 210 of file UN_Iterator.h.

Constructor & Destructor Documentation

template<bool CHILD_ONLY>

UN_NodeWireIterator< CHILD_ONLY >::UN_NodeWireIterator ( UN_GraphData *  graph_data, UN_NodeID  node_id  )

inline

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

Definition at line 216 of file UN_Iterator.h.

template<bool CHILD_ONLY>

UN_NodeWireIterator< CHILD_ONLY >::UN_NodeWireIterator ( UN_GraphData *  graph_data )

inline

Constructor for the end iterator.

Definition at line 224 of file UN_Iterator.h.

Member Function Documentation

template<bool CHILD_ONLY>

bool UN_NodeWireIterator< CHILD_ONLY >::operator!= ( const UN_NodeWireIterator< CHILD_ONLY > &  other ) const

inline

Comparison operator.

Definition at line 237 of file UN_Iterator.h.

template<bool CHILD_ONLY>

UN_Wire UN_NodeWireIterator< CHILD_ONLY >::operator*

(

)

const

Dereferencing operator, returns the handle to the wire inside the node.

template<bool CHILD_ONLY>

UN_NodeWireIterator& UN_NodeWireIterator< CHILD_ONLY >::operator++ ( )

inline

Increment operator.

Definition at line 230 of file UN_Iterator.h.

---

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

• UN/UN_Iterator.h