vtkInEdgeIterator Class Reference

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

#include <vtkInEdgeIterator.h>

Inheritance diagram for vtkInEdgeIterator:

Collaboration diagram for vtkInEdgeIterator:

Public Types
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	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 ()
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 vtkInEdgeIterator *	New ()
static int	IsTypeOf (const char *type)
static vtkInEdgeIterator *	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
	vtkInEdgeIterator ()
	~vtkInEdgeIterator ()
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 vtkInEdgeType *	Current
const vtkInEdgeType *	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 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 *  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 ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkInEdgeIterator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkInEdgeIterator* vtkInEdgeIterator::NewInstance

(

)

const

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 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:

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/DataModel/vtkInEdgeIterator.h