VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
vtkTreeBFSIterator Class Reference

breadth first search iterator through a vtkTree More...

#include <vtkTreeBFSIterator.h>

Inheritance diagram for vtkTreeBFSIterator:
[legend]
Collaboration diagram for vtkTreeBFSIterator:
[legend]

Public Types

enum  ModeType { DISCOVER, FINISH }
 
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase 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 ()
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char 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)
 
vtkCommandGetCommand (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)
 
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 &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkTreeBFSIteratorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkTreeBFSIteratorSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 

Protected Types

enum  ColorType { WHITE, GRAY, BLACK }
 

Protected Member Functions

 vtkTreeBFSIterator ()
 
 ~vtkTreeBFSIterator ()
 
void Initialize ()
 
vtkIdType NextInternal ()
 
- 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 &os)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkTree * Tree
 
int Mode
 
vtkIdType StartVertex
 
vtkIdType CurRoot
 
vtkTreeBFSIteratorInternals * Internals
 
vtkIntArrayColor
 
vtkIdType NextId
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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.

Member Typedef Documentation

Definition at line 47 of file vtkTreeBFSIterator.h.

Member Enumeration Documentation

Enumerator
DISCOVER 
FINISH 

Definition at line 51 of file vtkTreeBFSIterator.h.

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
virtual const char* vtkTreeBFSIterator::GetClassName ( )
virtual

Reimplemented from vtkObject.

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

static vtkTreeBFSIterator* vtkTreeBFSIterator::SafeDownCast ( vtkObject o)
static
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
vtkIdType vtkTreeBFSIterator::NextInternal ( )
protected

Member Data Documentation

vtkTree* vtkTreeBFSIterator::Tree
protected

Definition at line 92 of file vtkTreeBFSIterator.h.

int vtkTreeBFSIterator::Mode
protected

Definition at line 93 of file vtkTreeBFSIterator.h.

vtkIdType vtkTreeBFSIterator::StartVertex
protected

Definition at line 94 of file vtkTreeBFSIterator.h.

vtkIdType vtkTreeBFSIterator::CurRoot
protected

Definition at line 95 of file vtkTreeBFSIterator.h.

vtkTreeBFSIteratorInternals* vtkTreeBFSIterator::Internals
protected

Definition at line 96 of file vtkTreeBFSIterator.h.

vtkIntArray* vtkTreeBFSIterator::Color
protected

Definition at line 97 of file vtkTreeBFSIterator.h.

vtkIdType vtkTreeBFSIterator::NextId
protected

Definition at line 98 of file vtkTreeBFSIterator.h.


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