VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkOutEdgeIterator Class Reference

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

#include <vtkOutEdgeIterator.h>

Inheritance diagram for vtkOutEdgeIterator:
[legend]
Collaboration diagram for vtkOutEdgeIterator:
[legend]

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...
 
vtkOutEdgeIteratorNewInstance () 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...
 
virtual vtkGraphGetGraph ()
 Get the graph and vertex associated with this iterator. More...
 
virtual vtkIdType GetVertex ()
 
vtkOutEdgeType Next ()
 Returns the next edge in the graph. More...
 
vtkGraphEdgeNextGraphEdge ()
 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...
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkOutEdgeIteratorNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOutEdgeIteratorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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 ()
 
- 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

vtkGraphGraph
 
const vtkOutEdgeTypeCurrent
 
const vtkOutEdgeTypeEnd
 
vtkIdType Vertex
 
vtkGraphEdgeGraphEdge
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > 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 51 of file vtkOutEdgeIterator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 55 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

◆ Next()

vtkOutEdgeType vtkOutEdgeIterator::Next ( )
inline

Returns the next edge in the graph.

Definition at line 75 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 95 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 110 of file vtkOutEdgeIterator.h.

◆ Current

const vtkOutEdgeType* vtkOutEdgeIterator::Current
protected

Definition at line 111 of file vtkOutEdgeIterator.h.

◆ End

const vtkOutEdgeType* vtkOutEdgeIterator::End
protected

Definition at line 112 of file vtkOutEdgeIterator.h.

◆ Vertex

vtkIdType vtkOutEdgeIterator::Vertex
protected

Definition at line 113 of file vtkOutEdgeIterator.h.

◆ GraphEdge

vtkGraphEdge* vtkOutEdgeIterator::GraphEdge
protected

Definition at line 114 of file vtkOutEdgeIterator.h.


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