Abstract class for iterator over a vtkTree. More...

#include <vtkTreeIterator.h>

Inheritance diagram for vtkTreeIterator:

Collaboration diagram for vtkTreeIterator:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkTreeIterator *	NewInstance () const

virtual void	PrintSelf (ostream &os, vtkIndent indent)

vtkIdType	Next ()

bool	HasNext ()

void	Restart ()


void	SetTree (vtkTree *graph)

virtual vtkTree *	GetTree ()


void	SetStartVertex (vtkIdType vertex)

virtual vtkIdType	GetStartVertex ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkTreeIterator *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkTreeIterator ()

	~vtkTreeIterator ()

virtual void	Initialize ()=0

virtual vtkIdType	NextInternal ()=0

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkTree *	Tree

vtkIdType	StartVertex

vtkIdType	NextId

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Abstract class for iterator over a vtkTree.

The base class for tree iterators vtkTreeBFSIterator and vtkTreeDFSIterator.

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.

See also: vtkTreeBFSIterator vtkTreeDFSIterator

Definition at line 38 of file vtkTreeIterator.h.

Member Typedef Documentation

typedef vtkObject vtkTreeIterator::Superclass

Definition at line 41 of file vtkTreeIterator.h.

Constructor & Destructor Documentation

vtkTreeIterator::vtkTreeIterator ( )

protected

vtkTreeIterator::~vtkTreeIterator ( )

protected

Member Function Documentation

static int vtkTreeIterator::IsTypeOf ( const char * type )

static

virtual int vtkTreeIterator::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.

Reimplemented in vtkTreeDFSIterator, and vtkTreeBFSIterator.

static vtkTreeIterator* vtkTreeIterator::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkTreeIterator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkTreeDFSIterator, and vtkTreeBFSIterator.

vtkTreeIterator* vtkTreeIterator::NewInstance ( ) const

virtual void vtkTreeIterator::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.

Reimplemented in vtkTreeDFSIterator, and vtkTreeBFSIterator.

void vtkTreeIterator::SetTree ( vtkTree * graph )

Set/get the graph to iterate over.

virtual vtkTree* vtkTreeIterator::GetTree ( )

virtual

Set/get the graph to iterate over.

void vtkTreeIterator::SetStartVertex ( vtkIdType vertex )

The start vertex of the traversal. 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 vtkTreeIterator::GetStartVertex ( )

virtual

The start vertex of the traversal. 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 vtkTreeIterator::Next ( )

The next vertex visited in the graph.

bool vtkTreeIterator::HasNext ( )

Return true when all vertices have been visited.

void vtkTreeIterator::Restart ( )

Reset the iterator to its start vertex.

virtual void vtkTreeIterator::Initialize ( )

protectedpure virtual

Implemented in vtkTreeDFSIterator, and vtkTreeBFSIterator.

virtual vtkIdType vtkTreeIterator::NextInternal ( )

protectedpure virtual

Implemented in vtkTreeDFSIterator, and vtkTreeBFSIterator.

Member Data Documentation

vtkTree* vtkTreeIterator::Tree

protected

Definition at line 74 of file vtkTreeIterator.h.

vtkIdType vtkTreeIterator::StartVertex

protected

Definition at line 75 of file vtkTreeIterator.h.

vtkIdType vtkTreeIterator::NextId

protected

Definition at line 76 of file vtkTreeIterator.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/DataModel/vtkTreeIterator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation