vtkTreeBFSIterator Class Reference

breadth first search iterator through a vtkTree More...

#include <vtkTreeBFSIterator.h>

Inheritance diagram for vtkTreeBFSIterator:

Collaboration diagram for vtkTreeBFSIterator:

Public Types
typedef vtkTreeIterator	Superclass
Public Types inherited from vtkTreeIterator
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkTreeBFSIterator *	NewInstance () const
virtual void	PrintSelf (ostream &os, vtkIndent indent)
Public Member Functions inherited from vtkTreeIterator
vtkTreeIterator *	NewInstance () const
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 vtkTreeBFSIterator *	New ()
static int	IsTypeOf (const char *type)
static vtkTreeBFSIterator *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkTreeIterator
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 Types
enum	ColorType { WHITE, GRAY, BLACK }

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkTreeBFSIterator ()
	~vtkTreeBFSIterator ()
virtual void	Initialize ()
virtual vtkIdType	NextInternal ()
Protected Member Functions inherited from vtkTreeIterator
	vtkTreeIterator ()
	~vtkTreeIterator ()
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
vtkTreeBFSIteratorInternals *	Internals
vtkIntArray *	Color
Protected Attributes inherited from vtkTreeIterator
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

breadth first search iterator through a vtkTree

vtkTreeBFSIterator performs a breadth first search traversal 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 42 of file vtkTreeBFSIterator.h.

Member Typedef Documentation

typedef vtkTreeIterator vtkTreeBFSIterator::Superclass

Definition at line 46 of file vtkTreeBFSIterator.h.

Member Enumeration Documentation

enum vtkTreeBFSIterator::ColorType

protected

Enumerator
WHITE
GRAY
BLACK

Definition at line 60 of file vtkTreeBFSIterator.h.

Constructor & Destructor Documentation

vtkTreeBFSIterator::vtkTreeBFSIterator ( )

protected

vtkTreeBFSIterator::~vtkTreeBFSIterator ( )

protected

Member Function Documentation

static vtkTreeBFSIterator* vtkTreeBFSIterator::New ( )

static

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

static

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

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

static

virtual vtkObjectBase* vtkTreeBFSIterator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkTreeIterator.

vtkTreeBFSIterator* vtkTreeBFSIterator::NewInstance

(

)

const

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

virtual void vtkTreeBFSIterator::Initialize ( )

protectedvirtual

Implements vtkTreeIterator.

virtual vtkIdType vtkTreeBFSIterator::NextInternal ( )

protectedvirtual

Implements vtkTreeIterator.

Member Data Documentation

vtkTreeBFSIteratorInternals* vtkTreeBFSIterator::Internals

protected

Definition at line 56 of file vtkTreeBFSIterator.h.

vtkIntArray* vtkTreeBFSIterator::Color

protected

Definition at line 57 of file vtkTreeBFSIterator.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/vtkTreeBFSIterator.h