vtkInEdgeIterator Class Reference

Iterates through all incoming edges to a vertex. More...

#include <vtkInEdgeIterator.h>

Inherits vtkObject.

Collaboration diagram for vtkInEdgeIterator:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkInEdgeIterator *	NewInstance () const
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 (vtkObjectBase *o)

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkInEdgeIterator ()
	~vtkInEdgeIterator ()
virtual void	SetGraph (vtkGraph *graph)

Protected Attributes
vtkGraph *	Graph
const vtkInEdgeType *	Current
const vtkInEdgeType *	End
vtkIdType	Vertex
vtkGraphEdge *	GraphEdge

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 47 of file vtkInEdgeIterator.h.

Member Typedef Documentation

typedef vtkObject vtkInEdgeIterator::Superclass

Definition at line 51 of file vtkInEdgeIterator.h.

Constructor & Destructor Documentation

vtkInEdgeIterator::vtkInEdgeIterator ( )

protected

vtkInEdgeIterator::~vtkInEdgeIterator ( )

protected

Member Function Documentation

static vtkInEdgeIterator* vtkInEdgeIterator::New ( )

static

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

static

virtual int vtkInEdgeIterator::IsA ( const char *  type )

virtual

static vtkInEdgeIterator* vtkInEdgeIterator::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkInEdgeIterator::NewInstanceInternal ( ) const

protectedvirtual

vtkInEdgeIterator* vtkInEdgeIterator::NewInstance

(

)

const

void vtkInEdgeIterator::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

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 66 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 83 of file vtkInEdgeIterator.h.

virtual void vtkInEdgeIterator::SetGraph ( vtkGraph *  graph )

protectedvirtual

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

Member Data Documentation

vtkGraph* vtkInEdgeIterator::Graph

protected

Definition at line 96 of file vtkInEdgeIterator.h.

const vtkInEdgeType* vtkInEdgeIterator::Current

protected

Definition at line 97 of file vtkInEdgeIterator.h.

const vtkInEdgeType* vtkInEdgeIterator::End

protected

Definition at line 98 of file vtkInEdgeIterator.h.

vtkIdType vtkInEdgeIterator::Vertex

protected

Definition at line 99 of file vtkInEdgeIterator.h.

vtkGraphEdge* vtkInEdgeIterator::GraphEdge

protected

Definition at line 100 of file vtkInEdgeIterator.h.

---

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

• dox/Common/DataModel/vtkInEdgeIterator.h