vtkOutEdgeIterator Class Reference

#include <vtkOutEdgeIterator.h>

Inheritance diagram for vtkOutEdgeIterator:

[legend]

Collaboration diagram for vtkOutEdgeIterator:

[legend]

List of all members.

Detailed Description

Iterates through all outgoing edges from a vertex.

vtkOutEdgeIterator iterates through all edges whose source is a particular vertex. Instantiate this class directly and call Initialize() to traverse the vertex of a graph. Alternately, use GetInEdges() on the graph to initialize the iterator. it->Next() returns a vtkOutEdgeType structure, which contains Id, the edge's id, and Target, the edge's target vertex.

See also:: vtkGraph vtkInEdgeIterator

Examples:: vtkOutEdgeIterator (Examples)

Tests:: vtkOutEdgeIterator (Tests)

Definition at line 49 of file vtkOutEdgeIterator.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)
void	Initialize (vtkGraph *g, vtkIdType v)
vtkGraphEdge *	NextGraphEdge ()

virtual vtkGraph *	GetGraph ()
virtual vtkIdType	GetVertex ()

vtkOutEdgeType	Next ()

bool	HasNext ()
Static Public Member Functions
static vtkOutEdgeIterator *	New ()
static int	IsTypeOf (const char *type)
static vtkOutEdgeIterator *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkOutEdgeIterator ()
	~vtkOutEdgeIterator ()
virtual void	SetGraph (vtkGraph *graph)
Protected Attributes
vtkGraph *	Graph
const vtkOutEdgeType *	Current
const vtkOutEdgeType *	End
vtkIdType	Vertex
vtkGraphEdge *	GraphEdge

Member Typedef Documentation

typedef vtkObject vtkOutEdgeIterator::Superclass

Reimplemented from vtkObject.

Definition at line 53 of file vtkOutEdgeIterator.h.

Constructor & Destructor Documentation

vtkOutEdgeIterator::vtkOutEdgeIterator ( ) [protected]

vtkOutEdgeIterator::~vtkOutEdgeIterator ( ) [protected]

Member Function Documentation

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

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

Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

static int vtkOutEdgeIterator::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

virtual int vtkOutEdgeIterator::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 vtkOutEdgeIterator* vtkOutEdgeIterator::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkObject.

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

Initialize the iterator with a graph and vertex.

virtual vtkGraph* vtkOutEdgeIterator::GetGraph ( ) [virtual]

Get the graph and vertex associated with this iterator.

virtual vtkIdType vtkOutEdgeIterator::GetVertex ( ) [virtual]

Get the graph and vertex associated with this iterator.

vtkOutEdgeType vtkOutEdgeIterator::Next ( ) [inline]

Returns the next edge in the graph.

Definition at line 68 of file vtkOutEdgeIterator.h.

vtkGraphEdge* vtkOutEdgeIterator::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 vtkOutEdgeIterator::HasNext ( ) [inline]

Whether this iterator has more edges.

Definition at line 85 of file vtkOutEdgeIterator.h.

virtual void vtkOutEdgeIterator::SetGraph ( vtkGraph * graph ) [protected, virtual]

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