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

depth first iterator through a vtkGraph More...

#include <vtkTreeDFSIterator.h>

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

Public Types

enum  ModeType { DISCOVER, FINISH }
 
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)
 
vtkTreeDFSIterator * NewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
void SetMode (int mode)
 
virtual int GetMode ()
 
- 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 vtkTreeDFSIterator * New ()
 
static int IsTypeOf (const char *type)
 
static vtkTreeDFSIterator * 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
 
 vtkTreeDFSIterator ()
 
 ~vtkTreeDFSIterator ()
 
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

int Mode
 
vtkIdType CurRoot
 
vtkTreeDFSIteratorInternals * 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

depth first iterator through a vtkGraph

vtkTreeDFSIterator performs a depth first search traversal of a tree.

First, you must set the tree on which you are going to iterate, and then optionally set the starting vertex and mode. The mode is either DISCOVER (default), 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.

Tests:
vtkTreeDFSIterator (Tests)

Definition at line 49 of file vtkTreeDFSIterator.h.

Member Typedef Documentation

typedef vtkTreeIterator vtkTreeDFSIterator::Superclass

Definition at line 53 of file vtkTreeDFSIterator.h.

Member Enumeration Documentation

enum vtkTreeDFSIterator::ModeType
Enumerator
DISCOVER 
FINISH 

Definition at line 57 of file vtkTreeDFSIterator.h.

enum vtkTreeDFSIterator::ColorType
protected
Enumerator
WHITE 
GRAY 
BLACK 

Definition at line 87 of file vtkTreeDFSIterator.h.

Constructor & Destructor Documentation

vtkTreeDFSIterator::vtkTreeDFSIterator ( )
protected
vtkTreeDFSIterator::~vtkTreeDFSIterator ( )
protected

Member Function Documentation

static vtkTreeDFSIterator* vtkTreeDFSIterator::New ( )
static
static int vtkTreeDFSIterator::IsTypeOf ( const char *  type)
static
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 vtkTreeIterator.

static vtkTreeDFSIterator* vtkTreeDFSIterator::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkTreeDFSIterator::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkTreeIterator.

vtkTreeDFSIterator* vtkTreeDFSIterator::NewInstance ( ) const
virtual 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 vtkTreeIterator.

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.

virtual void vtkTreeDFSIterator::Initialize ( )
protectedvirtual

Implements vtkTreeIterator.

virtual vtkIdType vtkTreeDFSIterator::NextInternal ( )
protectedvirtual

Implements vtkTreeIterator.

Member Data Documentation

int vtkTreeDFSIterator::Mode
protected

Definition at line 81 of file vtkTreeDFSIterator.h.

vtkIdType vtkTreeDFSIterator::CurRoot
protected

Definition at line 82 of file vtkTreeDFSIterator.h.

vtkTreeDFSIteratorInternals* vtkTreeDFSIterator::Internals
protected

Definition at line 83 of file vtkTreeDFSIterator.h.

vtkIntArray* vtkTreeDFSIterator::Color
protected

Definition at line 84 of file vtkTreeDFSIterator.h.

The documentation for this class was generated from the following file:
Generated on Wed Dec 16 2015 17:20:40 for VTK by   doxygen 1.8.9.1