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 Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkInEdgeIterator *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	Initialize (vtkGraph *g, vtkIdType v)
	Initialize the iterator with a graph and vertex. More...

vtkGraphEdge *	NextGraphEdge ()
	Just like Next(), but returns heavy-weight vtkGraphEdge object instead of the vtkEdgeType struct, for use with wrappers. More...

bool	HasNext ()
	Whether this iterator has more edges. More...


virtual vtkGraph *	GetGraph ()
	Get the graph and vertex associated with this iterator. More...

virtual vtkIdType	GetVertex ()
	Get the graph and vertex associated with this iterator. More...


vtkInEdgeType	Next ()
	Returns the next edge in the graph. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

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 vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkInEdgeIterator ()

	~vtkInEdgeIterator () override

virtual void	SetGraph (vtkGraph *graph)
	Protected method for setting the graph used by Initialize(). More...

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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

Member Typedef Documentation

typedef vtkObject vtkInEdgeIterator::Superclass

Definition at line 52 of file vtkInEdgeIterator.h.

Constructor & Destructor Documentation

vtkInEdgeIterator::vtkInEdgeIterator ( )

protected

vtkInEdgeIterator::~vtkInEdgeIterator ( )

overrideprotected

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 vtkObjectBase.

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

static

virtual vtkObjectBase* vtkInEdgeIterator::NewInstanceInternal ( ) const

protectedvirtual

vtkInEdgeIterator* vtkInEdgeIterator::NewInstance ( ) const

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

overridevirtual

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 72 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 92 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 107 of file vtkInEdgeIterator.h.

const vtkInEdgeType* vtkInEdgeIterator::Current

protected

Definition at line 108 of file vtkInEdgeIterator.h.

const vtkInEdgeType* vtkInEdgeIterator::End

protected

Definition at line 109 of file vtkInEdgeIterator.h.

vtkIdType vtkInEdgeIterator::Vertex

protected

Definition at line 110 of file vtkInEdgeIterator.h.

vtkGraphEdge* vtkInEdgeIterator::GraphEdge

protected

Definition at line 111 of file vtkInEdgeIterator.h.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Common/DataModel/vtkInEdgeIterator.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