vtkAdjacentVertexIterator Class Reference

#include <vtkAdjacentVertexIterator.h>

Inheritance diagram for vtkAdjacentVertexIterator:

Inheritance graph
[legend]
Collaboration diagram for vtkAdjacentVertexIterator:

Collaboration graph
[legend]

List of all members.


Detailed Description

Iterates through adjacent vertices in a graph.

vtkAdjacentVertexIterator iterates through all vertices adjacent to a vertex, i.e. the vertices which may be reached by traversing an out edge of the source vertex. Use graph->GetAdjacentVertices(v, it) to initialize the iterator.

Tests:
vtkAdjacentVertexIterator (Tests)

Definition at line 45 of file vtkAdjacentVertexIterator.h.


Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void Initialize (vtkGraph *g, vtkIdType v)
virtual vtkGraphGetGraph ()
virtual vtkIdType GetVertex ()
vtkIdType Next ()
bool HasNext ()

Static Public Member Functions

static vtkAdjacentVertexIteratorNew ()
static int IsTypeOf (const char *type)
static vtkAdjacentVertexIteratorSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkAdjacentVertexIterator ()
 ~vtkAdjacentVertexIterator ()
virtual void SetGraph (vtkGraph *graph)

Protected Attributes

vtkGraphGraph
const vtkOutEdgeTypeCurrent
const vtkOutEdgeTypeEnd
vtkIdType Vertex

Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 49 of file vtkAdjacentVertexIterator.h.


Constructor & Destructor Documentation

vtkAdjacentVertexIterator::vtkAdjacentVertexIterator (  )  [protected]

vtkAdjacentVertexIterator::~vtkAdjacentVertexIterator (  )  [protected]


Member Function Documentation

static vtkAdjacentVertexIterator* vtkAdjacentVertexIterator::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkAdjacentVertexIterator::GetClassName (  )  [virtual]

Reimplemented from vtkObject.

static int vtkAdjacentVertexIterator::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

virtual int vtkAdjacentVertexIterator::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkAdjacentVertexIterator* vtkAdjacentVertexIterator::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkObject.

void vtkAdjacentVertexIterator::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 vtkAdjacentVertexIterator::Initialize ( vtkGraph g,
vtkIdType  v 
)

Initialize the iterator with a graph and vertex.

virtual vtkGraph* vtkAdjacentVertexIterator::GetGraph (  )  [virtual]

Get the graph and vertex associated with this iterator.

virtual vtkIdType vtkAdjacentVertexIterator::GetVertex (  )  [virtual]

Get the graph and vertex associated with this iterator.

vtkIdType vtkAdjacentVertexIterator::Next (  )  [inline]

Returns the next edge in the graph.

Definition at line 63 of file vtkAdjacentVertexIterator.h.

bool vtkAdjacentVertexIterator::HasNext (  )  [inline]

Whether this iterator has more edges.

Definition at line 73 of file vtkAdjacentVertexIterator.h.

virtual void vtkAdjacentVertexIterator::SetGraph ( vtkGraph graph  )  [protected, virtual]

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


Member Data Documentation

Definition at line 86 of file vtkAdjacentVertexIterator.h.

Definition at line 87 of file vtkAdjacentVertexIterator.h.

Definition at line 88 of file vtkAdjacentVertexIterator.h.

Definition at line 89 of file vtkAdjacentVertexIterator.h.


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

Generated on Wed Jun 3 18:52:46 2009 for VTK by  doxygen 1.5.6