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

An undirected graph. More...

#include <vtkUndirectedGraph.h>

Inheritance diagram for vtkUndirectedGraph:
[legend]

Public Types

typedef vtkGraph Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int GetDataObjectType ()
 
virtual vtkIdType GetInDegree (vtkIdType v)
 
virtual bool IsStructureValid (vtkGraph *g)
 
virtual vtkInEdgeType GetInEdge (vtkIdType v, vtkIdType i)
 
virtual void GetInEdge (vtkIdType v, vtkIdType i, vtkGraphEdge *e)
 
virtual void GetInEdges (vtkIdType v, vtkInEdgeIterator *it)
 

Static Public Member Functions

static vtkUndirectedGraphNew ()
 
static int IsTypeOf (const char *type)
 
static vtkUndirectedGraphSafeDownCast (vtkObject *o)
 
static vtkUndirectedGraphGetData (vtkInformation *info)
 
static vtkUndirectedGraphGetData (vtkInformationVector *v, int i=0)
 

Protected Member Functions

 vtkUndirectedGraph ()
 
 ~vtkUndirectedGraph ()
 
virtual void GetInEdges (vtkIdType v, const vtkInEdgeType *&edges, vtkIdType &nedges)
 

Detailed Description

An undirected graph.

vtkUndirectedGraph is a collection of vertices along with a collection of undirected edges (they connect two vertices in no particular order). ShallowCopy(), DeepCopy(), CheckedShallowCopy(), CheckedDeepCopy() accept instances of vtkUndirectedGraph and vtkMutableUndirectedGraph. GetOutEdges(v, it) and GetInEdges(v, it) return the same list of edges, which is the list of all edges which have a v as an endpoint. GetInDegree(v), GetOutDegree(v) and GetDegree(v) all return the full degree of vertex v.

vtkUndirectedGraph is read-only. To create an undirected graph, use an instance of vtkMutableUndirectedGraph, then you may set the structure to a vtkUndirectedGraph using ShallowCopy().

See Also
vtkGraph vtkMutableUndirectedGraph
Examples:
vtkUndirectedGraph (Examples)
Tests:
vtkUndirectedGraph (Tests)

Definition at line 52 of file vtkUndirectedGraph.h.

Member Typedef Documentation

Definition at line 56 of file vtkUndirectedGraph.h.

Constructor & Destructor Documentation

vtkUndirectedGraph::vtkUndirectedGraph ( )
protected
vtkUndirectedGraph::~vtkUndirectedGraph ( )
protected

Member Function Documentation

static vtkUndirectedGraph* vtkUndirectedGraph::New ( )
static
virtual const char* vtkUndirectedGraph::GetClassName ( )
virtual

Reimplemented in vtkMutableUndirectedGraph.

static int vtkUndirectedGraph::IsTypeOf ( const char *  type)
static
virtual int vtkUndirectedGraph::IsA ( const char *  type)
virtual

Reimplemented in vtkMutableUndirectedGraph.

static vtkUndirectedGraph* vtkUndirectedGraph::SafeDownCast ( vtkObject o)
static
void vtkUndirectedGraph::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual int vtkUndirectedGraph::GetDataObjectType ( )
inlinevirtual

Return what type of dataset this is.

Definition at line 60 of file vtkUndirectedGraph.h.

virtual vtkIdType vtkUndirectedGraph::GetInDegree ( vtkIdType  v)
virtual

Returns the full degree of the vertex.

virtual vtkInEdgeType vtkUndirectedGraph::GetInEdge ( vtkIdType  v,
vtkIdType  i 
)
virtual

Random-access method for retrieving the in edges of a vertex. For an undirected graph, this is the same as the out edges.

virtual void vtkUndirectedGraph::GetInEdge ( vtkIdType  v,
vtkIdType  i,
vtkGraphEdge e 
)
inlinevirtual

Random-access method for retrieving incoming edges to vertex v. The method fills the vtkGraphEdge instance with the id, source, and target of the edge. This method is provided for wrappers, GetInEdge(vtkIdType, vtkIdType) is preferred.

Definition at line 78 of file vtkUndirectedGraph.h.

static vtkUndirectedGraph* vtkUndirectedGraph::GetData ( vtkInformation info)
static

Retrieve a graph from an information vector.

static vtkUndirectedGraph* vtkUndirectedGraph::GetData ( vtkInformationVector v,
int  i = 0 
)
static

Retrieve a graph from an information vector.

virtual void vtkUndirectedGraph::GetInEdges ( vtkIdType  v,
vtkInEdgeIterator it 
)
inlinevirtual

Initialize the iterator to get the incoming edges to a vertex. For an undirected graph, this is all incident edges.

Definition at line 93 of file vtkUndirectedGraph.h.

virtual bool vtkUndirectedGraph::IsStructureValid ( vtkGraph *  g)
virtual

Check the structure, and accept it if it is a valid undirected graph. This is public to allow the ToDirected/UndirectedGraph to work.

virtual void vtkUndirectedGraph::GetInEdges ( vtkIdType  v,
const vtkInEdgeType *&  edges,
vtkIdType nedges 
)
protectedvirtual

For iterators, returns the same edge list as GetOutEdges().


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