VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
vtkTreeDFSIterator Class Reference

depth first iterator through a vtkGraph More...

#include <vtkTreeDFSIterator.h>

Inheritance diagram for vtkTreeDFSIterator:
Inheritance graph
[legend]
Collaboration diagram for vtkTreeDFSIterator:
Collaboration graph
[legend]

List of all members.

Public Types

enum  ModeType { DISCOVER, FINISH }
typedef vtkTreeIterator Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
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 (vtkObject *o)

Protected Types

enum  ColorType { WHITE, GRAY, BLACK }

Protected Member Functions

 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 48 of file vtkTreeDFSIterator.h.


Member Typedef Documentation

Reimplemented from vtkTreeIterator.

Definition at line 52 of file vtkTreeDFSIterator.h.


Member Enumeration Documentation

Enumerator:
DISCOVER 
FINISH 

Definition at line 56 of file vtkTreeDFSIterator.h.

Enumerator:
WHITE 
GRAY 
BLACK 

Definition at line 86 of file vtkTreeDFSIterator.h.


Constructor & Destructor Documentation

vtkTreeDFSIterator::vtkTreeDFSIterator ( ) [protected]
vtkTreeDFSIterator::~vtkTreeDFSIterator ( ) [protected]

Member Function Documentation

static vtkTreeDFSIterator* vtkTreeDFSIterator::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkTreeDFSIterator::GetClassName ( ) [virtual]

Reimplemented from vtkTreeIterator.

static int vtkTreeDFSIterator::IsTypeOf ( const char *  name) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkTreeIterator.

virtual int vtkTreeDFSIterator::IsA ( const char *  name) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkTreeIterator.

static vtkTreeDFSIterator* vtkTreeDFSIterator::SafeDownCast ( vtkObject o) [static]

Reimplemented from vtkTreeIterator.

virtual void vtkTreeDFSIterator::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkTreeIterator.

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 ( ) [protected, virtual]

Implements vtkTreeIterator.

virtual vtkIdType vtkTreeDFSIterator::NextInternal ( ) [protected, virtual]

Implements vtkTreeIterator.


Member Data Documentation

Definition at line 80 of file vtkTreeDFSIterator.h.

Definition at line 81 of file vtkTreeDFSIterator.h.

vtkTreeDFSIteratorInternals* vtkTreeDFSIterator::Internals [protected]

Definition at line 82 of file vtkTreeDFSIterator.h.

Definition at line 83 of file vtkTreeDFSIterator.h.


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