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 Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkAdjacentVertexIteratorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Initialize (vtkGraph *g, vtkIdType v)
 Initialize the iterator with a graph and vertex. More...
 
bool HasNext ()
 Whether this iterator has more edges. More...
 
virtual vtkGraphGetGraph ()
 Get the graph and vertex associated with this iterator. More...
 
virtual vtkIdType GetVertex ()
 Get the graph and vertex associated with this iterator. More...
 
vtkIdType Next ()
 Returns the next edge in the graph. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkAdjacentVertexIteratorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAdjacentVertexIteratorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAdjacentVertexIterator ()
 
 ~vtkAdjacentVertexIterator () override
 
virtual void SetGraph (vtkGraph *graph)
 Protected method for setting the graph used by Initialize(). More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- 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 47 of file vtkAdjacentVertexIterator.h.

Member Typedef Documentation

Definition at line 51 of file vtkAdjacentVertexIterator.h.

Constructor & Destructor Documentation

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

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

static vtkAdjacentVertexIterator* vtkAdjacentVertexIterator::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkAdjacentVertexIterator::NewInstanceInternal ( ) const
protectedvirtual
vtkAdjacentVertexIterator* vtkAdjacentVertexIterator::NewInstance ( ) const
void vtkAdjacentVertexIterator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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 71 of file vtkAdjacentVertexIterator.h.

bool vtkAdjacentVertexIterator::HasNext ( )
inline

Whether this iterator has more edges.

Definition at line 82 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 97 of file vtkAdjacentVertexIterator.h.

const vtkOutEdgeType* vtkAdjacentVertexIterator::Current
protected

Definition at line 98 of file vtkAdjacentVertexIterator.h.

const vtkOutEdgeType* vtkAdjacentVertexIterator::End
protected

Definition at line 99 of file vtkAdjacentVertexIterator.h.

vtkIdType vtkAdjacentVertexIterator::Vertex
protected

Definition at line 100 of file vtkAdjacentVertexIterator.h.


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