Iterates through all outgoing edges from a vertex. More...

#include <vtkOutEdgeIterator.h>

Inheritance diagram for vtkOutEdgeIterator:

Collaboration diagram for vtkOutEdgeIterator:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkOutEdgeIterator *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	Initialize (vtkGraph *g, vtkIdType v)

vtkGraphEdge *	NextGraphEdge ()


virtual vtkGraph *	GetGraph ()

virtual vtkIdType	GetVertex ()


vtkOutEdgeType	Next ()


bool	HasNext ()

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 vtkOutEdgeIterator *	New ()

static int	IsTypeOf (const char *type)

static vtkOutEdgeIterator *	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

	vtkOutEdgeIterator ()

	~vtkOutEdgeIterator ()

virtual void	SetGraph (vtkGraph *graph)

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

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 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 50 of file vtkOutEdgeIterator.h.

Member Typedef Documentation

typedef vtkObject vtkOutEdgeIterator::Superclass

Definition at line 54 of file vtkOutEdgeIterator.h.

Constructor & Destructor Documentation

vtkOutEdgeIterator::vtkOutEdgeIterator ( )

protected

vtkOutEdgeIterator::~vtkOutEdgeIterator ( )

protected

Member Function Documentation

static vtkOutEdgeIterator* vtkOutEdgeIterator::New ( )

static

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

static

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 ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkOutEdgeIterator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkOutEdgeIterator* vtkOutEdgeIterator::NewInstance ( ) const

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 69 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 86 of file vtkOutEdgeIterator.h.

virtual void vtkOutEdgeIterator::SetGraph ( vtkGraph * graph )

protectedvirtual

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

Member Data Documentation

vtkGraph* vtkOutEdgeIterator::Graph

protected

Definition at line 99 of file vtkOutEdgeIterator.h.

const vtkOutEdgeType* vtkOutEdgeIterator::Current

protected

Definition at line 100 of file vtkOutEdgeIterator.h.

const vtkOutEdgeType* vtkOutEdgeIterator::End

protected

Definition at line 101 of file vtkOutEdgeIterator.h.

vtkIdType vtkOutEdgeIterator::Vertex

protected

Definition at line 102 of file vtkOutEdgeIterator.h.

vtkGraphEdge* vtkOutEdgeIterator::GraphEdge

protected

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation