Orfeo Toolbox  4.0
Public Types | Public Member Functions | Private Attributes | List of all members
otb::RCC8VertexIterator< TGraph > Class Template Reference

Iterates on the graph vertices. More...

#include <otbRCC8VertexIterator.h>

Public Types

typedef GraphType::Pointer GraphPointerType
 
typedef TGraph GraphType
 
typedef boost::property_map
< InternalGraphType,
boost::vertex_index_t >::type 
IndexMapType
 
typedef
GraphType::InternalGraphType 
InternalGraphType
 
typedef boost::graph_traits
< InternalGraphType >
::vertex_iterator 
InternalIteratorType
 
typedef RCC8VertexIterator Self
 
typedef
GraphType::VertexDescriptorType 
VertexDescriptorType
 
typedef
GraphType::VertexPointerType 
VertexPointerType
 

Public Member Functions

 RCC8VertexIterator ()
 
 RCC8VertexIterator (const Self &iter)
 
 RCC8VertexIterator (TGraph *graph)
 
VertexPointerType Get (void)
 
VertexDescriptorType GetIndex (void)
 
void GoToBegin (void)
 
bool IsAtEnd (void)
 
bool operator!= (const Self &it)
 
Selfoperator+ (int i)
 
Selfoperator++ ()
 
Selfoperator- (int i)
 
Selfoperator-- ()
 
Selfoperator= (const Self &it)
 
bool operator== (const Self &it)
 
void Set (VertexPointerType vertex)
 

Private Attributes

InternalIteratorType m_End
 
GraphPointerType m_Graph
 
InternalIteratorType m_Iter
 

Detailed Description

template<class TGraph>
class otb::RCC8VertexIterator< TGraph >

Iterates on the graph vertices.

Definition at line 30 of file otbRCC8VertexIterator.h.

Member Typedef Documentation

template<class TGraph>
typedef GraphType::Pointer otb::RCC8VertexIterator< TGraph >::GraphPointerType

Definition at line 39 of file otbRCC8VertexIterator.h.

template<class TGraph>
typedef TGraph otb::RCC8VertexIterator< TGraph >::GraphType

Graph typedef

Definition at line 37 of file otbRCC8VertexIterator.h.

template<class TGraph>
typedef boost::property_map<InternalGraphType, boost::vertex_index_t>::type otb::RCC8VertexIterator< TGraph >::IndexMapType

Typedef of the index map

Definition at line 45 of file otbRCC8VertexIterator.h.

template<class TGraph>
typedef GraphType::InternalGraphType otb::RCC8VertexIterator< TGraph >::InternalGraphType

Definition at line 38 of file otbRCC8VertexIterator.h.

template<class TGraph>
typedef boost::graph_traits<InternalGraphType>::vertex_iterator otb::RCC8VertexIterator< TGraph >::InternalIteratorType

typedef of the internal iterator

Definition at line 43 of file otbRCC8VertexIterator.h.

template<class TGraph>
typedef RCC8VertexIterator otb::RCC8VertexIterator< TGraph >::Self

self typedef

Definition at line 34 of file otbRCC8VertexIterator.h.

template<class TGraph>
typedef GraphType::VertexDescriptorType otb::RCC8VertexIterator< TGraph >::VertexDescriptorType

Definition at line 41 of file otbRCC8VertexIterator.h.

template<class TGraph>
typedef GraphType::VertexPointerType otb::RCC8VertexIterator< TGraph >::VertexPointerType

Definition at line 40 of file otbRCC8VertexIterator.h.

Constructor & Destructor Documentation

template<class TGraph >
otb::RCC8VertexIterator< TGraph >::RCC8VertexIterator ( )

Constructor

Definition at line 30 of file otbRCC8VertexIterator.txx.

template<class TGraph >
otb::RCC8VertexIterator< TGraph >::RCC8VertexIterator ( const Self iter)
template<class TGraph>
otb::RCC8VertexIterator< TGraph >::RCC8VertexIterator ( TGraph *  graph)

Constructor with input graph

*Constructor with input graph

Definition at line 51 of file otbRCC8VertexIterator.txx.

Member Function Documentation

template<class TGraph >
RCC8VertexIterator< TGraph >::VertexPointerType otb::RCC8VertexIterator< TGraph >::Get ( void  )

Get the current vertex.

Returns
The current vertex pointed by the iterator.

Get the current object.

Returns
The current object pointed by the iterator.

Definition at line 64 of file otbRCC8VertexIterator.txx.

Referenced by otb::PolygonListToRCC8GraphFilter< TPolygonList, TOutputGraph >::ThreadedGenerateData().

template<class TGraph >
RCC8VertexIterator< TGraph >::VertexDescriptorType otb::RCC8VertexIterator< TGraph >::GetIndex ( void  )

Get the current vertex index.

Returns
The current vertex index.

Definition at line 87 of file otbRCC8VertexIterator.txx.

Referenced by otb::PolygonListToRCC8GraphFilter< TPolygonList, TOutputGraph >::ThreadedGenerateData().

template<class TGraph >
void otb::RCC8VertexIterator< TGraph >::GoToBegin ( void  )
template<class TGraph >
bool otb::RCC8VertexIterator< TGraph >::IsAtEnd ( void  )

Return true if the iterator is at the end.

Returns
True if the iterator is at the end.

Definition at line 99 of file otbRCC8VertexIterator.txx.

Referenced by otb::PolygonListToRCC8GraphFilter< TPolygonList, TOutputGraph >::ThreadedGenerateData().

template<class TGraph >
bool otb::RCC8VertexIterator< TGraph >::operator!= ( const Self iter)

Difference comparison operator.

Definition at line 167 of file otbRCC8VertexIterator.txx.

References otb::RCC8VertexIterator< TGraph >::m_Iter.

template<class TGraph >
RCC8VertexIterator< TGraph >::Self & otb::RCC8VertexIterator< TGraph >::operator+ ( int  i)

Add

Definition at line 144 of file otbRCC8VertexIterator.txx.

template<class TGraph >
RCC8VertexIterator< TGraph >::Self & otb::RCC8VertexIterator< TGraph >::operator++ ( )

Increment.

Definition at line 120 of file otbRCC8VertexIterator.txx.

template<class TGraph >
RCC8VertexIterator< TGraph >::Self & otb::RCC8VertexIterator< TGraph >::operator- ( int  i)

Remove

Definition at line 156 of file otbRCC8VertexIterator.txx.

template<class TGraph >
RCC8VertexIterator< TGraph >::Self & otb::RCC8VertexIterator< TGraph >::operator-- ( )

Decrement.

Definition at line 132 of file otbRCC8VertexIterator.txx.

template<class TGraph >
RCC8VertexIterator< TGraph >::Self & otb::RCC8VertexIterator< TGraph >::operator= ( const Self iter)

Instantiation operator.

Definition at line 188 of file otbRCC8VertexIterator.txx.

References otb::RCC8VertexIterator< TGraph >::m_Iter.

template<class TGraph >
bool otb::RCC8VertexIterator< TGraph >::operator== ( const Self iter)

Equality comparison operator.

Definition at line 177 of file otbRCC8VertexIterator.txx.

References otb::RCC8VertexIterator< TGraph >::m_Iter.

template<class TGraph >
void otb::RCC8VertexIterator< TGraph >::Set ( VertexPointerType  vertex)

Set the current vertex.

Parameters
vertexThe vertex to set.

Definition at line 75 of file otbRCC8VertexIterator.txx.

Member Data Documentation

template<class TGraph>
InternalIteratorType otb::RCC8VertexIterator< TGraph >::m_End
private
template<class TGraph>
GraphPointerType otb::RCC8VertexIterator< TGraph >::m_Graph
private
template<class TGraph>
InternalIteratorType otb::RCC8VertexIterator< TGraph >::m_Iter
private

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

Generated at Sat Mar 8 2014 18:52:00 for Orfeo Toolbox with doxygen 1.8.3.1