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

Iterates through adjacent vertices in a graph. More...

#include <vtkAdjacentVertexIterator.h>

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

Public Types

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

Public Member Functions

virtual int IsA (const char *type)
 
vtkAdjacentVertexIteratorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void Initialize (vtkGraph *g, vtkIdType v)
 
virtual vtkGraphGetGraph ()
 
virtual vtkIdType GetVertex ()
 
vtkIdType Next ()
 
bool HasNext ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () 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)
 
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)
 
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 vtkAdjacentVertexIteratorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAdjacentVertexIteratorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *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 Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAdjacentVertexIterator ()
 
 ~vtkAdjacentVertexIterator ()
 
virtual void SetGraph (vtkGraph *graph)
 
- 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

vtkGraphGraph
 
const vtkOutEdgeTypeCurrent
 
const vtkOutEdgeTypeEnd
 
vtkIdType Vertex
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Iterates through adjacent vertices in a graph.

vtkAdjacentVertexIterator iterates through all vertices adjacent to a vertex, i.e. the vertices which may be reached by traversing an out edge of the source vertex. Use graph->GetAdjacentVertices(v, it) to initialize the iterator.

Tests:
vtkAdjacentVertexIterator (Tests)

Definition at line 46 of file vtkAdjacentVertexIterator.h.

Member Typedef Documentation

Definition at line 50 of file vtkAdjacentVertexIterator.h.

Constructor & Destructor Documentation

vtkAdjacentVertexIterator::vtkAdjacentVertexIterator ( )
protected
vtkAdjacentVertexIterator::~vtkAdjacentVertexIterator ( )
protected

Member Function Documentation

static vtkAdjacentVertexIterator* vtkAdjacentVertexIterator::New ( )
static
static int vtkAdjacentVertexIterator::IsTypeOf ( const char *  type)
static
virtual int vtkAdjacentVertexIterator::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 vtkAdjacentVertexIterator* vtkAdjacentVertexIterator::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkAdjacentVertexIterator::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkObject.

vtkAdjacentVertexIterator* vtkAdjacentVertexIterator::NewInstance ( ) const
void vtkAdjacentVertexIterator::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 vtkAdjacentVertexIterator::Initialize ( vtkGraph g,
vtkIdType  v 
)

Initialize the iterator with a graph and vertex.

virtual vtkGraph* vtkAdjacentVertexIterator::GetGraph ( )
virtual

Get the graph and vertex associated with this iterator.

virtual vtkIdType vtkAdjacentVertexIterator::GetVertex ( )
virtual

Get the graph and vertex associated with this iterator.

vtkIdType vtkAdjacentVertexIterator::Next ( )
inline

Returns the next edge in the graph.

Definition at line 64 of file vtkAdjacentVertexIterator.h.

bool vtkAdjacentVertexIterator::HasNext ( )
inline

Whether this iterator has more edges.

Definition at line 74 of file vtkAdjacentVertexIterator.h.

virtual void vtkAdjacentVertexIterator::SetGraph ( vtkGraph graph)
protectedvirtual

Protected method for setting the graph used by Initialize().

Member Data Documentation

vtkGraph* vtkAdjacentVertexIterator::Graph
protected

Definition at line 87 of file vtkAdjacentVertexIterator.h.

const vtkOutEdgeType* vtkAdjacentVertexIterator::Current
protected

Definition at line 88 of file vtkAdjacentVertexIterator.h.

const vtkOutEdgeType* vtkAdjacentVertexIterator::End
protected

Definition at line 89 of file vtkAdjacentVertexIterator.h.

vtkIdType vtkAdjacentVertexIterator::Vertex
protected

Definition at line 90 of file vtkAdjacentVertexIterator.h.


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