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

A rooted tree data structure. More...

#include <vtkDirectedAcyclicGraph.h>

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

Public Types

typedef vtkDirectedGraph Superclass
- Public Types inherited from vtkDirectedGraph
typedef vtkGraph Superclass
- Public Types inherited from vtkGraph
typedef vtkDataObject Superclass
- Public Types inherited from vtkDataObject
typedef vtkObject Superclass
enum  FieldAssociations {
  FIELD_ASSOCIATION_POINTS, FIELD_ASSOCIATION_CELLS, FIELD_ASSOCIATION_NONE, FIELD_ASSOCIATION_POINTS_THEN_CELLS,
  FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, FIELD_ASSOCIATION_ROWS, NUMBER_OF_ASSOCIATIONS
}
enum  AttributeTypes {
  POINT, CELL, FIELD, POINT_THEN_CELL,
  VERTEX, EDGE, ROW, NUMBER_OF_ATTRIBUTE_TYPES
}
enum  FieldOperations { FIELD_OPERATION_PRESERVED, FIELD_OPERATION_REINTERPOLATED, FIELD_OPERATION_MODIFIED, FIELD_OPERATION_REMOVED }
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual int GetDataObjectType ()

Static Public Member Functions

static vtkDirectedAcyclicGraph * New ()
static int IsTypeOf (const char *type)
static vtkDirectedAcyclicGraph * SafeDownCast (vtkObject *o)
static vtkDirectedAcyclicGraph * GetData (vtkInformation *info)
static vtkDirectedAcyclicGraph * GetData (vtkInformationVector *v, int i=0)
- Static Public Member Functions inherited from vtkDataObject
static const char * GetAssociationTypeAsString (int associationType)
static vtkInformationStringKey * DATA_TYPE_NAME ()
static
vtkInformationDataObjectKey * 
DATA_OBJECT ()
static vtkInformationIntegerKey * DATA_EXTENT_TYPE ()
static
vtkInformationIntegerPointerKey * 
DATA_EXTENT ()
static vtkInformationIntegerKey * DATA_PIECE_NUMBER ()
static vtkInformationIntegerKey * DATA_NUMBER_OF_PIECES ()
static vtkInformationIntegerKey * DATA_NUMBER_OF_GHOST_LEVELS ()
static vtkInformationDoubleKey * DATA_RESOLUTION ()
static
vtkInformationDoubleVectorKey * 
DATA_TIME_STEPS ()
static
vtkInformationInformationVectorKey * 
POINT_DATA_VECTOR ()
static
vtkInformationInformationVectorKey * 
CELL_DATA_VECTOR ()
static
vtkInformationInformationVectorKey * 
VERTEX_DATA_VECTOR ()
static
vtkInformationInformationVectorKey * 
EDGE_DATA_VECTOR ()
static vtkInformationIntegerKey * FIELD_ARRAY_TYPE ()
static vtkInformationIntegerKey * FIELD_ASSOCIATION ()
static vtkInformationIntegerKey * FIELD_ATTRIBUTE_TYPE ()
static vtkInformationIntegerKey * FIELD_ACTIVE_ATTRIBUTE ()
static vtkInformationIntegerKey * FIELD_NUMBER_OF_COMPONENTS ()
static vtkInformationIntegerKey * FIELD_NUMBER_OF_TUPLES ()
static vtkInformationIntegerKey * FIELD_OPERATION ()
static
vtkInformationDoubleVectorKey * 
FIELD_RANGE ()
static
vtkInformationDoubleVectorKey * 
PIECE_FIELD_RANGE ()
static vtkInformationStringKey * FIELD_ARRAY_NAME ()
static
vtkInformationIntegerVectorKey * 
PIECE_EXTENT ()
static vtkInformationStringKey * FIELD_NAME ()
static
vtkInformationDoubleVectorKey * 
ORIGIN ()
static
vtkInformationDoubleVectorKey * 
SPACING ()
static vtkInformationIntegerKey * DATA_GEOMETRY_UNMODIFIED ()
static
vtkInformationDataObjectKey * 
SIL ()
static vtkInformation * GetActiveFieldInformation (vtkInformation *info, int fieldAssociation, int attributeType)
static vtkInformation * GetNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
static void RemoveNamedFieldInformation (vtkInformation *info, int fieldAssociation, const char *name)
static vtkInformation * SetActiveAttribute (vtkInformation *info, int fieldAssociation, const char *attributeName, int attributeType)
static void SetActiveAttributeInfo (vtkInformation *info, int fieldAssociation, int attributeType, const char *name, int arrayType, int numComponents, int numTuples)
static void SetPointDataActiveScalarInfo (vtkInformation *info, int arrayType, int numComponents)
static void SetGlobalReleaseDataFlag (int val)
static int GetGlobalReleaseDataFlag ()
- Static Public Member Functions inherited from vtkObject
static void BreakOnError ()
static void SetGlobalWarningDisplay (int val)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static int GetGlobalWarningDisplay ()

Protected Member Functions

 vtkDirectedAcyclicGraph ()
 ~vtkDirectedAcyclicGraph ()
virtual bool IsStructureValid (vtkGraph *g)
- Protected Member Functions inherited from vtkDirectedGraph
 vtkDirectedGraph ()
 ~vtkDirectedGraph ()
- Protected Member Functions inherited from vtkGraph
 vtkGraph ()
 ~vtkGraph ()
void AddVertexInternal (const vtkVariant &pedigree, vtkIdType *vertex)
void RemoveVertexInternal (vtkIdType v, bool directed)
void RemoveEdgeInternal (vtkIdType e, bool directed)
void RemoveVerticesInternal (vtkIdTypeArray *arr, bool directed)
virtual void CopyInternal (vtkGraph *g, bool deep)
void SetInternals (vtkGraphInternals *internals)
void SetEdgePoints (vtkGraphEdgePoints *edgePoints)
void ForceOwnership ()
void BuildEdgeList ()
void AddVertexInternal (vtkVariantArray *propertyArr=0, vtkIdType *vertex=0)
void AddEdgeInternal (vtkIdType u, vtkIdType v, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)
void AddEdgeInternal (const vtkVariant &uPedigree, vtkIdType v, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)
void AddEdgeInternal (vtkIdType u, const vtkVariant &vPedigree, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)
void AddEdgeInternal (const vtkVariant &uPedigree, const vtkVariant &vPedigree, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)
void RemoveEdgesInternal (vtkIdTypeArray *arr, bool directed)
virtual void GetOutEdges (vtkIdType v, const vtkOutEdgeType *&edges, vtkIdType &nedges)
virtual void GetInEdges (vtkIdType v, const vtkInEdgeType *&edges, vtkIdType &nedges)
virtual vtkIdTypeArray * GetEdgeList ()
virtual void SetEdgeList (vtkIdTypeArray *list)
- Protected Member Functions inherited from vtkDataObject
 vtkDataObject ()
 ~vtkDataObject ()
vtkExecutive * GetExecutive ()
int GetPortNumber ()
virtual void ReportReferences (vtkGarbageCollector *)
vtkStreamingDemandDrivenPipeline * TrySDDP (const char *method)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Additional Inherited Members

- Protected Types inherited from vtkDataObject
typedef
vtkStreamingDemandDrivenPipeline 
SDDP
- Protected Attributes inherited from vtkGraph
vtkGraphInternals * Internals
vtkDistributedGraphHelper * DistributedHelper
vtkGraphEdgePoints * EdgePoints
double Bounds [6]
vtkTimeStamp ComputeTime
vtkDataSetAttributes * VertexData
vtkDataSetAttributes * EdgeData
vtkPoints * Points
vtkIdTypeArray * EdgeList
- Static Protected Attributes inherited from vtkGraph
static double DefaultPoint [3]
- Static Protected Attributes inherited from vtkDataObject
static const char AssociationNames [NUMBER_OF_ASSOCIATIONS][55]

Detailed Description

A rooted tree data structure.

vtkDirectedAcyclicGraph is a connected directed graph with no cycles. A tree is a type of directed graph, so works with all graph algorithms.

vtkDirectedAcyclicGraph is a read-only data structure. To construct a tree, create an instance of vtkMutableDirectedGraph. Add vertices and edges with AddVertex() and AddEdge(). You may alternately start by adding a single vertex as the root then call graph->AddChild(parent) which adds a new vertex and connects the parent to the child. The tree MUST have all edges in the proper direction, from parent to child. After building the tree, call tree->CheckedShallowCopy(graph) to copy the structure into a vtkDirectedAcyclicGraph. This method will return false if the graph is an invalid tree.

vtkDirectedAcyclicGraph provides some convenience methods for obtaining the parent and children of a vertex, for finding the root, and determining if a vertex is a leaf (a vertex with no children).

See Also
vtkDirectedGraph vtkMutableDirectedGraph vtkGraph
Tests:
vtkDirectedAcyclicGraph (Tests)

Definition at line 55 of file vtkDirectedAcyclicGraph.h.

Member Typedef Documentation

Definition at line 59 of file vtkDirectedAcyclicGraph.h.

Constructor & Destructor Documentation

vtkDirectedAcyclicGraph::vtkDirectedAcyclicGraph ( )
protected
vtkDirectedAcyclicGraph::~vtkDirectedAcyclicGraph ( )
protected

Member Function Documentation

static vtkDirectedAcyclicGraph* vtkDirectedAcyclicGraph::New ( )
static

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

Reimplemented from vtkDirectedGraph.

Reimplemented in vtkTree.

virtual const char* vtkDirectedAcyclicGraph::GetClassName ( )
virtual

Reimplemented from vtkDirectedGraph.

Reimplemented in vtkTree.

static int vtkDirectedAcyclicGraph::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 vtkDirectedGraph.

Reimplemented in vtkTree.

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

Reimplemented in vtkTree.

static vtkDirectedAcyclicGraph* vtkDirectedAcyclicGraph::SafeDownCast ( vtkObject *  o)
static

Reimplemented from vtkDirectedGraph.

Reimplemented in vtkTree.

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

Reimplemented in vtkTree.

virtual int vtkDirectedAcyclicGraph::GetDataObjectType ( )
inlinevirtual

Return what type of dataset this is.

Reimplemented from vtkDirectedGraph.

Reimplemented in vtkTree.

Definition at line 63 of file vtkDirectedAcyclicGraph.h.

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

Retrieve a graph from an information vector.

Reimplemented from vtkDirectedGraph.

Reimplemented in vtkTree.

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

Retrieve a graph from an information vector.

Reimplemented from vtkDirectedGraph.

Reimplemented in vtkTree.

virtual bool vtkDirectedAcyclicGraph::IsStructureValid ( vtkGraph *  g)
protectedvirtual

Check the storage, and accept it if it is a valid tree.

Reimplemented from vtkDirectedGraph.

Reimplemented in vtkTree.


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