vtkDirectedGraph Class Reference

#include <vtkDirectedGraph.h>

Inheritance diagram for vtkDirectedGraph:

Inheritance graph
[legend]
Collaboration diagram for vtkDirectedGraph:

Collaboration graph
[legend]

List of all members.


Detailed Description

A directed graph.

vtkDirectedGraph is a collection of vertices along with a collection of directed edges (edges that have a source and target). ShallowCopy() and DeepCopy() (and CheckedShallowCopy(), CheckedDeepCopy()) accept instances of vtkTree and vtkMutableDirectedGraph.

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

See also:
vtkGraph vtkMutableDirectedGraph
Tests:
vtkDirectedGraph (Tests)
Including this header allows you to use a vtkDirectedGraph* in boost algorithms. To do this, first wrap the class in a vtkDirectedGraph* or vtkUndirectedGraph* depending on whether your graph is directed or undirected. You may then use these objects directly in boost graph algorithms.

Definition at line 45 of file vtkDirectedGraph.h.


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 bool IsStructureValid (vtkGraph *g)

Static Public Member Functions

static vtkDirectedGraphNew ()
static int IsTypeOf (const char *type)
static vtkDirectedGraphSafeDownCast (vtkObject *o)
static vtkDirectedGraphGetData (vtkInformation *info)
static vtkDirectedGraphGetData (vtkInformationVector *v, int i=0)

Protected Member Functions

 vtkDirectedGraph ()
 ~vtkDirectedGraph ()

Member Typedef Documentation

Reimplemented from vtkGraph.

Reimplemented in vtkDirectedAcyclicGraph, vtkMutableDirectedGraph, vtkReebGraph, and vtkTree.

Definition at line 49 of file vtkDirectedGraph.h.


Constructor & Destructor Documentation

vtkDirectedGraph::vtkDirectedGraph (  )  [protected]

vtkDirectedGraph::~vtkDirectedGraph (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkDataObject.

Reimplemented in vtkDirectedAcyclicGraph, vtkMutableDirectedGraph, vtkReebGraph, and vtkTree.

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

Reimplemented from vtkGraph.

Reimplemented in vtkDirectedAcyclicGraph, vtkMutableDirectedGraph, vtkReebGraph, and vtkTree.

static int vtkDirectedGraph::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkGraph.

Reimplemented in vtkDirectedAcyclicGraph, vtkMutableDirectedGraph, vtkReebGraph, and vtkTree.

virtual int vtkDirectedGraph::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 vtkGraph.

Reimplemented in vtkDirectedAcyclicGraph, vtkMutableDirectedGraph, vtkReebGraph, and vtkTree.

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

Reimplemented from vtkGraph.

Reimplemented in vtkDirectedAcyclicGraph, vtkMutableDirectedGraph, vtkReebGraph, and vtkTree.

void vtkDirectedGraph::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 vtkGraph.

Reimplemented in vtkDirectedAcyclicGraph, vtkMutableDirectedGraph, vtkReebGraph, and vtkTree.

virtual int vtkDirectedGraph::GetDataObjectType (  )  [inline, virtual]

Return what type of dataset this is.

Reimplemented from vtkGraph.

Reimplemented in vtkDirectedAcyclicGraph, and vtkTree.

Definition at line 53 of file vtkDirectedGraph.h.

static vtkDirectedGraph* vtkDirectedGraph::GetData ( vtkInformation info  )  [static]

Retrieve a graph from an information vector.

Reimplemented from vtkGraph.

Reimplemented in vtkDirectedAcyclicGraph, and vtkTree.

static vtkDirectedGraph* vtkDirectedGraph::GetData ( vtkInformationVector v,
int  i = 0 
) [static]

Retrieve a graph from an information vector.

Reimplemented from vtkGraph.

Reimplemented in vtkDirectedAcyclicGraph, and vtkTree.

virtual bool vtkDirectedGraph::IsStructureValid ( vtkGraph g  )  [virtual]

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

Implements vtkGraph.

Reimplemented in vtkDirectedAcyclicGraph, and vtkTree.


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

Generated on Wed Aug 24 11:33:58 2011 for VTK by  doxygen 1.5.6