vtkTreeBFSIterator Class Reference

#include <vtkTreeBFSIterator.h>

Inheritance diagram for vtkTreeBFSIterator:

[legend]

Collaboration diagram for vtkTreeBFSIterator:

[legend]

List of all members.

Detailed Description

breadth first search iterator through a vtkTree

vtkTreeBFSIterator performs a breadth first search of a tree.

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.

Thanks:: Thanks to David Doria for submitting this class.

Tests:: vtkTreeBFSIterator (Tests)

Definition at line 43 of file vtkTreeBFSIterator.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 vtkTreeBFSIterator *	New ()
static int	IsTypeOf (const char *type)
static vtkTreeBFSIterator *	SafeDownCast (vtkObject *o)
Protected Types
enum	ColorType { WHITE, GRAY, BLACK }
Protected Member Functions
	vtkTreeBFSIterator ()
	~vtkTreeBFSIterator ()
void	Initialize ()
vtkIdType	NextInternal ()
Protected Attributes
vtkTree *	Tree
int	Mode
vtkIdType	StartVertex
vtkIdType	CurRoot
vtkTreeBFSIteratorInternals *	Internals
vtkIntArray *	Color
vtkIdType	NextId

Member Typedef Documentation

typedef vtkObject vtkTreeBFSIterator::Superclass

Reimplemented from vtkObject.

Definition at line 47 of file vtkTreeBFSIterator.h.

Member Enumeration Documentation

enum vtkTreeBFSIterator::ModeType

Enumerator:

DISCOVER
FINISH

Definition at line 51 of file vtkTreeBFSIterator.h.

enum vtkTreeBFSIterator::ColorType [protected]

Enumerator:

WHITE
GRAY
BLACK

Definition at line 101 of file vtkTreeBFSIterator.h.

Constructor & Destructor Documentation

vtkTreeBFSIterator::vtkTreeBFSIterator ( ) [protected]

vtkTreeBFSIterator::~vtkTreeBFSIterator ( ) [protected]

Member Function Documentation

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

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

Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

static int vtkTreeBFSIterator::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 vtkTreeBFSIterator::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 vtkTreeBFSIterator* vtkTreeBFSIterator::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkObject.

void vtkTreeBFSIterator::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 vtkTreeBFSIterator::SetTree ( vtkTree * graph )

Set the graph to iterate over.

void vtkTreeBFSIterator::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 vtkTreeBFSIterator::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 vtkTreeBFSIterator::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 vtkTreeBFSIterator::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 vtkTreeBFSIterator::Next ( )

The next vertex visited in the graph.

bool vtkTreeBFSIterator::HasNext ( )

Return true when all vertices have been visited.

void vtkTreeBFSIterator::Initialize ( ) [protected]