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

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


vtkOutEdgeType	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 ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output. More...

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

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

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

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes. More...

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes. More...

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

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. 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...

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not. More...

Static Public Member Functions
static vtkOutEdgeIterator *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkOutEdgeIterator *	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 vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

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

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOutEdgeIterator ()

	~vtkOutEdgeIterator () 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=nullptr)
	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	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

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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)

Online Examples:

OutEdgeIterator

Tests:: vtkOutEdgeIterator (Tests)

Definition at line 71 of file vtkOutEdgeIterator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkOutEdgeIterator::Superclass

Definition at line 75 of file vtkOutEdgeIterator.h.

Constructor & Destructor Documentation

◆ vtkOutEdgeIterator()

vtkOutEdgeIterator::vtkOutEdgeIterator ( )

protected

◆ ~vtkOutEdgeIterator()

vtkOutEdgeIterator::~vtkOutEdgeIterator ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkOutEdgeIterator* vtkOutEdgeIterator::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOutEdgeIterator::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkOutEdgeIterator* vtkOutEdgeIterator::NewInstance ( ) const

◆ PrintSelf()

void vtkOutEdgeIterator::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.

◆ Initialize()

void vtkOutEdgeIterator::Initialize	(	vtkGraph *	g,
		vtkIdType	v
	)

Initialize the iterator with a graph and vertex.

◆ GetGraph()

virtual vtkGraph* vtkOutEdgeIterator::GetGraph ( )

virtual

Get the graph and vertex associated with this iterator.

◆ GetVertex()

virtual vtkIdType vtkOutEdgeIterator::GetVertex ( )

virtual

Get the graph and vertex associated with this iterator.

◆ Next()

vtkOutEdgeType vtkOutEdgeIterator::Next ( )

inline

Returns the next edge in the graph.

Definition at line 95 of file vtkOutEdgeIterator.h.

◆ NextGraphEdge()

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().

◆ HasNext()

bool vtkOutEdgeIterator::HasNext ( )

inline

Whether this iterator has more edges.

Definition at line 115 of file vtkOutEdgeIterator.h.

◆ SetGraph()

virtual void vtkOutEdgeIterator::SetGraph ( vtkGraph * graph )

protectedvirtual

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

Member Data Documentation

◆ Graph

vtkGraph* vtkOutEdgeIterator::Graph

protected

Definition at line 127 of file vtkOutEdgeIterator.h.

◆ Current

const vtkOutEdgeType* vtkOutEdgeIterator::Current

protected

Definition at line 128 of file vtkOutEdgeIterator.h.

◆ End

const vtkOutEdgeType* vtkOutEdgeIterator::End

protected

Definition at line 129 of file vtkOutEdgeIterator.h.

◆ Vertex

vtkIdType vtkOutEdgeIterator::Vertex

protected

Definition at line 130 of file vtkOutEdgeIterator.h.

◆ GraphEdge

vtkGraphEdge* vtkOutEdgeIterator::GraphEdge

protected

Definition at line 131 of file vtkOutEdgeIterator.h.

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

Common/DataModel/vtkOutEdgeIterator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkOutEdgeIterator()

◆ ~vtkOutEdgeIterator()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Initialize()

◆ GetGraph()

◆ GetVertex()

◆ Next()

◆ NextGraphEdge()

◆ HasNext()

◆ SetGraph()

Member Data Documentation

◆ Graph

◆ Current

◆ End

◆ Vertex

◆ GraphEdge