VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
vtkTreeDFSIterator Class Reference

depth first iterator through a vtkGraph More...

#include <vtkTreeDFSIterator.h>

Inherits vtkTreeIterator.

Collaboration diagram for vtkTreeDFSIterator:
[legend]

Public Types

enum  ModeType { DISCOVER, FINISH }
 
typedef vtkTreeIterator Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkTreeDFSIteratorNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
void SetMode (int mode)
 
virtual int GetMode ()
 

Static Public Member Functions

static vtkTreeDFSIteratorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkTreeDFSIteratorSafeDownCast (vtkObjectBase *o)
 

Protected Types

enum  ColorType { WHITE, GRAY, BLACK }
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkTreeDFSIterator ()
 
 ~vtkTreeDFSIterator ()
 
virtual void Initialize ()
 
virtual vtkIdType NextInternal ()
 

Protected Attributes

int Mode
 
vtkIdType CurRoot
 
vtkTreeDFSIteratorInternals * Internals
 
vtkIntArrayColor
 

Detailed Description

depth first iterator through a vtkGraph

vtkTreeDFSIterator performs a depth first search traversal of a tree.

First, you must set the tree on which you are going to iterate, and then optionally set the starting vertex and mode. The mode is either DISCOVER (default), in which case vertices are visited as they are first reached, or FINISH, in which case vertices are visited when they are done, i.e. all adjacent vertices have been discovered already.

After setting up the iterator, the normal mode of operation is to set up a while(iter->HasNext()) loop, with the statement vtkIdType vertex = iter->Next() inside the loop.

Tests:
vtkTreeDFSIterator (Tests)

Definition at line 49 of file vtkTreeDFSIterator.h.

Member Typedef Documentation

typedef vtkTreeIterator vtkTreeDFSIterator::Superclass

Definition at line 53 of file vtkTreeDFSIterator.h.

Member Enumeration Documentation

Enumerator
DISCOVER 
FINISH 

Definition at line 57 of file vtkTreeDFSIterator.h.

Enumerator
WHITE 
GRAY 
BLACK 

Definition at line 87 of file vtkTreeDFSIterator.h.

Constructor & Destructor Documentation

vtkTreeDFSIterator::vtkTreeDFSIterator ( )
protected
vtkTreeDFSIterator::~vtkTreeDFSIterator ( )
protected

Member Function Documentation

static vtkTreeDFSIterator* vtkTreeDFSIterator::New ( )
static
static int vtkTreeDFSIterator::IsTypeOf ( const char *  type)
static
virtual int vtkTreeDFSIterator::IsA ( const char *  type)
virtual
static vtkTreeDFSIterator* vtkTreeDFSIterator::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkTreeDFSIterator::NewInstanceInternal ( ) const
protectedvirtual
vtkTreeDFSIterator* vtkTreeDFSIterator::NewInstance ( ) const
virtual void vtkTreeDFSIterator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual
void vtkTreeDFSIterator::SetMode ( int  mode)

Set the visit mode of the iterator. Mode can be DISCOVER (0): Order by discovery time FINISH (1): Order by finish time Default is DISCOVER. Use DISCOVER for top-down algorithms where parents need to be processed before children. Use FINISH for bottom-up algorithms where children need to be processed before parents.

virtual int vtkTreeDFSIterator::GetMode ( )
virtual

Set the visit mode of the iterator. Mode can be DISCOVER (0): Order by discovery time FINISH (1): Order by finish time Default is DISCOVER. Use DISCOVER for top-down algorithms where parents need to be processed before children. Use FINISH for bottom-up algorithms where children need to be processed before parents.

virtual void vtkTreeDFSIterator::Initialize ( )
protectedvirtual
virtual vtkIdType vtkTreeDFSIterator::NextInternal ( )
protectedvirtual

Member Data Documentation

int vtkTreeDFSIterator::Mode
protected

Definition at line 81 of file vtkTreeDFSIterator.h.

vtkIdType vtkTreeDFSIterator::CurRoot
protected

Definition at line 82 of file vtkTreeDFSIterator.h.

vtkTreeDFSIteratorInternals* vtkTreeDFSIterator::Internals
protected

Definition at line 83 of file vtkTreeDFSIterator.h.

vtkIntArray* vtkTreeDFSIterator::Color
protected

Definition at line 84 of file vtkTreeDFSIterator.h.


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