vtkInEdgeIterator Class Reference

#include <vtkInEdgeIterator.h>

Inheritance diagram for vtkInEdgeIterator:

[legend]

Collaboration diagram for vtkInEdgeIterator:

[legend]

List of all members.

Detailed Description

Iterates through all incoming edges to a vertex.

vtkInEdgeIterator iterates through all edges whose target 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 vtkInEdgeType structure, which contains Id, the edge's id, and Source, the edge's source vertex.

See also:: vtkGraph vtkOutEdgeIterator

Tests:: vtkInEdgeIterator (Tests)

Definition at line 46 of file vtkInEdgeIterator.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 ()

vtkInEdgeType	Next ()

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

Member Typedef Documentation

typedef vtkObject vtkInEdgeIterator::Superclass

Reimplemented from vtkObject.

Definition at line 50 of file vtkInEdgeIterator.h.

Constructor & Destructor Documentation

vtkInEdgeIterator::vtkInEdgeIterator ( ) [protected]

vtkInEdgeIterator::~vtkInEdgeIterator ( ) [protected]

Member Function Documentation

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

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

Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

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

Initialize the iterator with a graph and vertex.

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

Get the graph and vertex associated with this iterator.

virtual vtkIdType vtkInEdgeIterator::GetVertex ( ) [virtual]

Get the graph and vertex associated with this iterator.

vtkInEdgeType vtkInEdgeIterator::Next ( ) [inline]

Returns the next edge in the graph.

Definition at line 65 of file vtkInEdgeIterator.h.

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

Whether this iterator has more edges.

Definition at line 82 of file vtkInEdgeIterator.h.

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

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