vtkEdgeListIterator Class Reference

Iterates through all edges in a graph. More...

#include <vtkEdgeListIterator.h>

Inheritance diagram for vtkEdgeListIterator:

Collaboration diagram for vtkEdgeListIterator:

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

Public Member Functions
virtual int	IsA (const char *type)
vtkEdgeListIterator *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkGraph *	GetGraph ()
virtual void	SetGraph (vtkGraph *graph)
vtkGraphEdge *	NextGraphEdge ()
bool	HasNext ()
vtkEdgeType	Next ()
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 vtkEdgeListIterator *	New ()
static int	IsTypeOf (const char *type)
static vtkEdgeListIterator *	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 Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkEdgeListIterator ()
	~vtkEdgeListIterator ()
void	Increment ()
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
vtkGraph *	Graph
const vtkOutEdgeType *	Current
const vtkOutEdgeType *	End
vtkIdType	Vertex
bool	Directed
vtkGraphEdge *	GraphEdge
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

Iterates through all edges in a graph.

vtkEdgeListIterator iterates through all the edges in a graph, by traversing the adjacency list for each vertex. You may instantiate this class directly and call SetGraph() to traverse a certain graph. You may also call the graph's GetEdges() method to set up the iterator for a certain graph.

Note that this class does NOT guarantee that the edges will be processed in order of their ids (i.e. it will not necessarily return edge 0, then edge 1, etc.).

See also

vtkGraph

Examples:

vtkEdgeListIterator (Examples)

Tests:

vtkEdgeListIterator (Tests)

Definition at line 55 of file vtkEdgeListIterator.h.

Member Typedef Documentation

typedef vtkObject vtkEdgeListIterator::Superclass

Definition at line 59 of file vtkEdgeListIterator.h.

Constructor & Destructor Documentation

vtkEdgeListIterator::vtkEdgeListIterator ( )

protected

vtkEdgeListIterator::~vtkEdgeListIterator ( )

protected

Member Function Documentation

static vtkEdgeListIterator* vtkEdgeListIterator::New ( )

static

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

static

virtual int vtkEdgeListIterator::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 vtkEdgeListIterator* vtkEdgeListIterator::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkEdgeListIterator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkEdgeListIterator* vtkEdgeListIterator::NewInstance

(

)

const

void vtkEdgeListIterator::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.

virtual vtkGraph* vtkEdgeListIterator::GetGraph ( )

virtual

virtual void vtkEdgeListIterator::SetGraph ( vtkGraph *  graph )

virtual

vtkEdgeType vtkEdgeListIterator::Next

(

)

Returns the next edge in the graph.

vtkGraphEdge* vtkEdgeListIterator::NextGraphEdge

(

)

Just like Next(), but returns heavy-weight vtkGraphEdge object instead of the vtkEdgeType struct, for use with wrappers. The graph edge is owned by this iterator, and changes after each call to NextGraphEdge().

bool vtkEdgeListIterator::HasNext

(

)

Whether this iterator has more edges.

void vtkEdgeListIterator::Increment ( )

protected

Member Data Documentation

vtkGraph* vtkEdgeListIterator::Graph

protected

Definition at line 87 of file vtkEdgeListIterator.h.

const vtkOutEdgeType* vtkEdgeListIterator::Current

protected

Definition at line 88 of file vtkEdgeListIterator.h.

const vtkOutEdgeType* vtkEdgeListIterator::End

protected

Definition at line 89 of file vtkEdgeListIterator.h.

vtkIdType vtkEdgeListIterator::Vertex

protected

Definition at line 90 of file vtkEdgeListIterator.h.

bool vtkEdgeListIterator::Directed

protected

Definition at line 91 of file vtkEdgeListIterator.h.

vtkGraphEdge* vtkEdgeListIterator::GraphEdge

protected

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