vtkEdgeListIterator Class Reference

#include <vtkEdgeListIterator.h>

Inheritance diagram for vtkEdgeListIterator:

[legend]

Collaboration diagram for vtkEdgeListIterator:

[legend]

List of all members.

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 54 of file vtkEdgeListIterator.h.


Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkGraph *	GetGraph ()
virtual void	SetGraph (vtkGraph *graph)
vtkGraphEdge *	NextGraphEdge ()
bool	HasNext ()

vtkEdgeType	Next ()
Static Public Member Functions
static vtkEdgeListIterator *	New ()
static int	IsTypeOf (const char *type)
static vtkEdgeListIterator *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkEdgeListIterator ()
	~vtkEdgeListIterator ()
void	Increment ()
Protected Attributes
vtkGraph *	Graph
const vtkOutEdgeType *	Current
const vtkOutEdgeType *	End
vtkIdType	Vertex
bool	Directed
vtkGraphEdge *	GraphEdge

Member Typedef Documentation

typedef vtkObject vtkEdgeListIterator::Superclass

Reimplemented from vtkObject.

Definition at line 58 of file vtkEdgeListIterator.h.

Constructor & Destructor Documentation

vtkEdgeListIterator::vtkEdgeListIterator ( ) [protected]

vtkEdgeListIterator::~vtkEdgeListIterator ( ) [protected]

Member Function Documentation

static vtkEdgeListIterator* vtkEdgeListIterator::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkEdgeListIterator::GetClassName ( ) [virtual]

Reimplemented from vtkObject.

static int vtkEdgeListIterator::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkEdgeListIterator* vtkEdgeListIterator::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkObject.

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]