HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UN_WireArrayPortIterator< IS_SOURCE_ITERATOR > Class Template Reference

#include <UN_Iterator.h>

+ Inheritance diagram for UN_WireArrayPortIterator< IS_SOURCE_ITERATOR >:

Public Types

using iterator_category = std::input_iterator_tag
 
using value_type = UN_Port
 
using difference_type = std::ptrdiff_t
 
using pointer = value_type *
 
using reference = value_type &
 
- Public Types inherited from UN_DataArrayIterator< UN_Wire, UN_WireIndexArray, UN_WireIDArray >
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_WireArrayPortIterator (UN_GraphData *graph_data, UN_WireIndexArray &&data_indices, UN_WireIDArray &&data_ids, exint begin=0)
 Constructor for the start iterator of the given data array. More...
 
 UN_WireArrayPortIterator (UN_GraphData *graph_data, exint end)
 Constructor for the end iterator. More...
 
UN_Port operator* () const
 
template<>
UN_API UN_Port operator* () const
 
template<>
UN_API UN_Port operator* () const
 
- Public Member Functions inherited from UN_DataArrayIterator< UN_Wire, UN_WireIndexArray, UN_WireIDArray >
 UN_DataArrayIterator (UN_GraphData *graph_data, UN_WireIndexArray &&data_indices, UN_WireIDArray &&data_ids, exint begin=0)
 Constructor for the start iterator of the given data array. More...
 
 UN_DataArrayIterator (UN_GraphData *graph_data, exint end)
 Constructor for the end iterator. More...
 
UN_DataArrayIteratoroperator++ ()
 Increment operator. More...
 
bool operator!= (const UN_DataArrayIterator &other) const
 Comparison operator. More...
 
UN_Wire operator* () const
 Dereferencing operator, returns the handle to the current data object. More...
 
UN_Wire handle () const
 Returns the handle to the current data object. More...
 

Detailed Description

template<bool IS_SOURCE_ITERATOR>
class UN_WireArrayPortIterator< IS_SOURCE_ITERATOR >

Iterator for traversing the input or output ports of the wire objects in the given wire index array. The iterator dereferences as a handle to the port data object. Used for iterating connected ports.

Definition at line 110 of file UN_Iterator.h.

Member Typedef Documentation

template<bool IS_SOURCE_ITERATOR>
using UN_WireArrayPortIterator< IS_SOURCE_ITERATOR >::difference_type = std::ptrdiff_t

Definition at line 116 of file UN_Iterator.h.

template<bool IS_SOURCE_ITERATOR>
using UN_WireArrayPortIterator< IS_SOURCE_ITERATOR >::iterator_category = std::input_iterator_tag

Definition at line 114 of file UN_Iterator.h.

template<bool IS_SOURCE_ITERATOR>
using UN_WireArrayPortIterator< IS_SOURCE_ITERATOR >::pointer = value_type*

Definition at line 117 of file UN_Iterator.h.

template<bool IS_SOURCE_ITERATOR>
using UN_WireArrayPortIterator< IS_SOURCE_ITERATOR >::reference = value_type&

Definition at line 118 of file UN_Iterator.h.

template<bool IS_SOURCE_ITERATOR>
using UN_WireArrayPortIterator< IS_SOURCE_ITERATOR >::value_type = UN_Port

Definition at line 115 of file UN_Iterator.h.

Constructor & Destructor Documentation

template<bool IS_SOURCE_ITERATOR>
UN_WireArrayPortIterator< IS_SOURCE_ITERATOR >::UN_WireArrayPortIterator ( UN_GraphData *  graph_data,
UN_WireIndexArray &&  data_indices,
UN_WireIDArray &&  data_ids,
exint  begin = 0 
)
inline

Constructor for the start iterator of the given data array.

Definition at line 121 of file UN_Iterator.h.

template<bool IS_SOURCE_ITERATOR>
UN_WireArrayPortIterator< IS_SOURCE_ITERATOR >::UN_WireArrayPortIterator ( UN_GraphData *  graph_data,
exint  end 
)
inline

Constructor for the end iterator.

Definition at line 130 of file UN_Iterator.h.

Member Function Documentation

template<bool IS_SOURCE_ITERATOR>
UN_Port UN_WireArrayPortIterator< IS_SOURCE_ITERATOR >::operator* ( ) const

Dereferencing operator, returns the handle to the connected port of the data object.

template<>
UN_API UN_Port UN_WireArrayPortIterator< true >::operator* ( ) const
template<>
UN_API UN_Port UN_WireArrayPortIterator< false >::operator* ( ) const

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