vtkDirectedGraph Class Reference

A directed graph. More...

#include <vtkDirectedGraph.h>

Inheritance diagram for vtkDirectedGraph:

Collaboration diagram for vtkDirectedGraph:

Public Types
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 int	IsA (const char *type)
vtkDirectedGraph *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	GetDataObjectType ()
virtual bool	IsStructureValid (vtkGraph *g)
Public Member Functions inherited from vtkGraph
vtkGraph *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Initialize ()
void	ComputeBounds ()
unsigned long int	GetMTime ()
virtual void	GetOutEdges (vtkIdType v, vtkOutEdgeIterator *it)
virtual vtkIdType	GetDegree (vtkIdType v)
virtual vtkIdType	GetOutDegree (vtkIdType v)
virtual void	GetOutEdge (vtkIdType v, vtkIdType index, vtkGraphEdge *e)
virtual void	GetInEdges (vtkIdType v, vtkInEdgeIterator *it)
virtual vtkIdType	GetInDegree (vtkIdType v)
virtual void	GetInEdge (vtkIdType v, vtkIdType index, vtkGraphEdge *e)
virtual void	GetAdjacentVertices (vtkIdType v, vtkAdjacentVertexIterator *it)
virtual void	GetEdges (vtkEdgeListIterator *it)
virtual vtkIdType	GetNumberOfEdges ()
virtual void	GetVertices (vtkVertexListIterator *it)
virtual vtkIdType	GetNumberOfVertices ()
void	SetDistributedGraphHelper (vtkDistributedGraphHelper *helper)
vtkIdType	FindVertex (const vtkVariant &pedigreeID)
virtual void	ShallowCopy (vtkDataObject *obj)
virtual void	DeepCopy (vtkDataObject *obj)
virtual void	CopyStructure (vtkGraph *g)
virtual bool	CheckedShallowCopy (vtkGraph *g)
virtual bool	CheckedDeepCopy (vtkGraph *g)
virtual void	Squeeze ()
void	ReorderOutVertices (vtkIdType v, vtkIdTypeArray *vertices)
bool	IsSameStructure (vtkGraph *other)
vtkIdType	GetNumberOfEdgePoints (vtkIdType e)
double *	GetEdgePoint (vtkIdType e, vtkIdType i)
void	ClearEdgePoints (vtkIdType e)
vtkGraphInternals *	GetGraphInternals (bool modifying)
void	GetInducedEdges (vtkIdTypeArray *verts, vtkIdTypeArray *edges)
virtual vtkFieldData *	GetAttributesAsFieldData (int type)
virtual vtkIdType	GetNumberOfElements (int type)
void	Dump ()
vtkIdType	GetEdgeId (vtkIdType a, vtkIdType b)
bool	ToDirectedGraph (vtkDirectedGraph *g)
bool	ToUndirectedGraph (vtkUndirectedGraph *g)
virtual vtkDataSetAttributes *	GetVertexData ()
virtual vtkDataSetAttributes *	GetEdgeData ()
double *	GetPoint (vtkIdType ptId)
void	GetPoint (vtkIdType ptId, double x[3])
vtkPoints *	GetPoints ()
virtual void	SetPoints (vtkPoints *points)
double *	GetBounds ()
void	GetBounds (double bounds[6])
virtual vtkOutEdgeType	GetOutEdge (vtkIdType v, vtkIdType index)
virtual vtkInEdgeType	GetInEdge (vtkIdType v, vtkIdType index)
vtkDistributedGraphHelper *	GetDistributedGraphHelper ()
vtkIdType	GetSourceVertex (vtkIdType e)
vtkIdType	GetTargetVertex (vtkIdType e)
void	SetEdgePoints (vtkIdType e, vtkIdType npts, double *pts)
void	GetEdgePoints (vtkIdType e, vtkIdType &npts, double *&pts)
void	SetEdgePoint (vtkIdType e, vtkIdType i, double x[3])
void	SetEdgePoint (vtkIdType e, vtkIdType i, double x, double y, double z)
void	AddEdgePoint (vtkIdType e, double x[3])
void	AddEdgePoint (vtkIdType e, double x, double y, double z)
void	ShallowCopyEdgePoints (vtkGraph *g)
void	DeepCopyEdgePoints (vtkGraph *g)
Public Member Functions inherited from vtkDataObject
vtkDataObject *	NewInstance () const
void	ReleaseData ()
unsigned long	GetUpdateTime ()
virtual unsigned long	GetActualMemorySize ()
virtual void	CopyInformationToPipeline (vtkInformation *vtkNotUsed(info))
void	DataHasBeenGenerated ()
virtual void	PrepareForNewData ()
virtual int	GetExtentType ()
virtual void	Crop (const int *updateExtent)
virtual vtkDataSetAttributes *	GetAttributes (int type)
virtual int	GetAttributeTypeForArray (vtkAbstractArray *arr)
virtual vtkInformation *	GetInformation ()
virtual void	SetInformation (vtkInformation *)
virtual int	GetDataReleased ()
virtual void	SetFieldData (vtkFieldData *)
virtual vtkFieldData *	GetFieldData ()
virtual void	CopyInformationFromPipeline (vtkInformation *vtkNotUsed(info))
void	GlobalReleaseDataFlagOn ()
void	GlobalReleaseDataFlagOff ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
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)
int	InvokeEvent (unsigned long event, void *callData)
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
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkDirectedGraph *	New ()
static int	IsTypeOf (const char *type)
static vtkDirectedGraph *	SafeDownCast (vtkObjectBase *o)
static vtkDirectedGraph *	GetData (vtkInformation *info)
static vtkDirectedGraph *	GetData (vtkInformationVector *v, int i=0)
Static Public Member Functions inherited from vtkGraph
static int	IsTypeOf (const char *type)
static vtkGraph *	SafeDownCast (vtkObjectBase *o)
static vtkGraph *	GetData (vtkInformation *info)
static vtkGraph *	GetData (vtkInformationVector *v, int i=0)
Static Public Member Functions inherited from vtkDataObject
static vtkDataObject *	New ()
static int	IsTypeOf (const char *type)
static vtkDataObject *	SafeDownCast (vtkObjectBase *o)
static const char *	GetAssociationTypeAsString (int associationType)
static int	GetAssociationTypeFromString (const char *associationType)
static vtkInformationStringKey *	DATA_TYPE_NAME ()
static vtkInformationDataObjectKey *	DATA_OBJECT ()
static vtkInformationIntegerKey *	DATA_EXTENT_TYPE ()
static vtkInformationIntegerPointerKey *	DATA_EXTENT ()
static vtkInformationIntegerVectorKey *	ALL_PIECES_EXTENT ()
static vtkInformationIntegerKey *	DATA_PIECE_NUMBER ()
static vtkInformationIntegerKey *	DATA_NUMBER_OF_PIECES ()
static vtkInformationIntegerKey *	DATA_NUMBER_OF_GHOST_LEVELS ()
static vtkInformationDoubleKey *	DATA_TIME_STEP ()
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 vtkInformationIntegerVectorKey *	PIECE_EXTENT ()
static vtkInformationStringKey *	FIELD_NAME ()
static vtkInformationDoubleVectorKey *	ORIGIN ()
static vtkInformationDoubleVectorKey *	SPACING ()
static vtkInformationDoubleVectorKey *	BOUNDING_BOX ()
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 vtkDataObject *	GetData (vtkInformation *info)
static vtkDataObject *	GetData (vtkInformationVector *v, int i=0)
static void	SetGlobalReleaseDataFlag (int val)
static int	GetGlobalReleaseDataFlag ()
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	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 ()
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 &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkGraph
vtkGraphInternals *	Internals
vtkDistributedGraphHelper *	DistributedHelper
vtkGraphEdgePoints *	EdgePoints
double	Bounds [6]
vtkTimeStamp	ComputeTime
vtkDataSetAttributes *	VertexData
vtkDataSetAttributes *	EdgeData
vtkPoints *	Points
vtkIdTypeArray *	EdgeList
Protected Attributes inherited from vtkDataObject
vtkFieldData *	FieldData
int	DataReleased
vtkTimeStamp	UpdateTime
vtkInformation *	Information
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers
Static Protected Attributes inherited from vtkGraph
static double	DefaultPoint [3]

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 46 of file vtkDirectedGraph.h.

Member Typedef Documentation

typedef vtkGraph vtkDirectedGraph::Superclass

Definition at line 50 of file vtkDirectedGraph.h.

Constructor & Destructor Documentation

vtkDirectedGraph::vtkDirectedGraph ( )

protected

vtkDirectedGraph::~vtkDirectedGraph ( )

protected

Member Function Documentation

static vtkDirectedGraph* vtkDirectedGraph::New ( )

static

static int vtkDirectedGraph::IsTypeOf ( const char *  type )

static

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 vtkReebGraph, vtkTree, vtkDirectedAcyclicGraph, and vtkMutableDirectedGraph.

static vtkDirectedGraph* vtkDirectedGraph::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkDirectedGraph::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkGraph.

Reimplemented in vtkReebGraph, vtkTree, vtkDirectedAcyclicGraph, and vtkMutableDirectedGraph.

vtkDirectedGraph* vtkDirectedGraph::NewInstance

(

)

const

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 vtkDataObject.

Reimplemented in vtkReebGraph, vtkTree, and vtkMutableDirectedGraph.

virtual int vtkDirectedGraph::GetDataObjectType ( )

inlinevirtual

Return what type of dataset this is.

Reimplemented from vtkGraph.

Reimplemented in vtkReebGraph, vtkTree, and vtkDirectedAcyclicGraph.

Definition at line 54 of file vtkDirectedGraph.h.

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

static

Retrieve a graph from an information vector.

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

static

Retrieve a graph from an information vector.

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 vtkTree, and vtkDirectedAcyclicGraph.

---

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

• dox/Common/DataModel/vtkDirectedGraph.h