vtkTreeDFSIterator Class Reference

#include <vtkTreeDFSIterator.h>

Inheritance diagram for vtkTreeDFSIterator:

[legend]

Collaboration diagram for vtkTreeDFSIterator:

[legend]

List of all members.

Detailed Description

depth first seedgeh iterator through a vtkGraph

vtkTreeDFSIterator performs a depth first seedgeh of a tree. First, you must set the tree on which you are going to iterate, and set the starting vertex and mode. The mode is either DISCOVER, 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.

Definition at line 46 of file vtkTreeDFSIterator.h.


Public Types
enum	ModeType { DISCOVER, FINISH }
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetTree (vtkTree *graph)
vtkIdType	Next ()
bool	HasNext ()

void	SetMode (int mode)
virtual int	GetMode ()

void	SetStartVertex (vtkIdType vertex)
virtual vtkIdType	GetStartVertex ()
Static Public Member Functions
static vtkTreeDFSIterator *	New ()
static int	IsTypeOf (const char *type)
static vtkTreeDFSIterator *	SafeDownCast (vtkObject *o)
Protected Types
enum	ColorType { WHITE, GRAY, BLACK }
Protected Member Functions
	vtkTreeDFSIterator ()
	~vtkTreeDFSIterator ()
void	Initialize ()
vtkIdType	NextInternal ()
Protected Attributes
vtkTree *	Tree
int	Mode
vtkIdType	StartVertex
vtkIdType	CurRoot
vtkTreeDFSIteratorInternals *	Internals
vtkIntArray *	Color
vtkIdType	NextId

Member Typedef Documentation

typedef vtkObject vtkTreeDFSIterator::Superclass

Reimplemented from vtkObject.

Definition at line 50 of file vtkTreeDFSIterator.h.

Member Enumeration Documentation

enum vtkTreeDFSIterator::ModeType

Enumerator:

DISCOVER
FINISH

Definition at line 54 of file vtkTreeDFSIterator.h.

enum vtkTreeDFSIterator::ColorType [protected]

Enumerator:

WHITE
GRAY
BLACK

Definition at line 104 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 vtkObject.

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 vtkObject.

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 vtkObject.

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

Reimplemented from vtkObject.

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 vtkObject.

void vtkTreeDFSIterator::SetTree ( vtkTree * graph )

Set the graph to iterate over.

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.

void vtkTreeDFSIterator::SetStartVertex ( vtkIdType vertex )

The start vertex of the seedgeh. The tree iterator will only iterate over the subtree rooted at vertex. If not set (or set to a negative value), starts at the root of the tree.

virtual vtkIdType vtkTreeDFSIterator::GetStartVertex ( ) [virtual]

The start vertex of the seedgeh. The tree iterator will only iterate over the subtree rooted at vertex. If not set (or set to a negative value), starts at the root of the tree.

vtkIdType vtkTreeDFSIterator::Next ( )

The next vertex visited in the graph.

bool vtkTreeDFSIterator::HasNext ( )

Return true when all vertices have been visited.

void vtkTreeDFSIterator::Initialize ( ) [protected]