VTK  9.3.20240418
vtkMutableDirectedGraph.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
3 // SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
134 #ifndef vtkMutableDirectedGraph_h
135 #define vtkMutableDirectedGraph_h
136 
137 #include "vtkCommonDataModelModule.h" // For export macro
138 #include "vtkDirectedGraph.h"
139 
140 VTK_ABI_NAMESPACE_BEGIN
141 class vtkEdgeListIterator;
142 class vtkGraphEdge;
143 class vtkVariant;
144 
145 class VTKCOMMONDATAMODEL_EXPORT vtkMutableDirectedGraph : public vtkDirectedGraph
146 {
147 public:
150  void PrintSelf(ostream& os, vtkIndent indent) override;
151 
165 
177 
197 
213  vtkIdType AddVertex(const vtkVariant& pedigreeId);
214 
224 
238 
251  vtkEdgeType AddEdge(const vtkVariant& u, vtkIdType v, vtkVariantArray* propertyArr = nullptr);
252 
265  vtkEdgeType AddEdge(vtkIdType u, const vtkVariant& v, vtkVariantArray* propertyArr = nullptr);
266 
280  const vtkVariant& u, const vtkVariant& v, vtkVariantArray* propertyArr = nullptr);
281 
290 
304  void LazyAddVertex(vtkVariantArray* propertyArr);
305 
316  void LazyAddVertex(const vtkVariant& pedigreeId);
317 
330  void LazyAddEdge(vtkIdType u, vtkIdType v, vtkVariantArray* propertyArr = nullptr);
331 
344  void LazyAddEdge(const vtkVariant& u, vtkIdType v, vtkVariantArray* propertyArr = nullptr);
345 
358  void LazyAddEdge(vtkIdType u, const vtkVariant& v, vtkVariantArray* propertyArr = nullptr);
359 
373  const vtkVariant& u, const vtkVariant& v, vtkVariantArray* propertyArr = nullptr);
374 
384 
398  vtkIdType AddChild(vtkIdType parent) { return this->AddChild(parent, nullptr); }
399 
405 
411 
416 
421 
422 protected:
425 
430 
431 private:
433  void operator=(const vtkMutableDirectedGraph&) = delete;
434 };
435 
436 VTK_ABI_NAMESPACE_END
437 #endif
A directed graph.
Iterates through all edges in a graph.
Representation of a single graph edge.
Definition: vtkGraphEdge.h:25
dynamic, self-adjusting array of vtkIdType
a simple class to control print indentation
Definition: vtkIndent.h:108
An editable directed graph.
void RemoveEdges(vtkIdTypeArray *arr)
Removes a collection of edges from the graph.
void RemoveEdge(vtkIdType e)
Removes the edge from the graph.
static vtkMutableDirectedGraph * New()
vtkGraphEdge * GraphEdge
Graph edge that is reused of AddGraphEdge calls.
void LazyAddEdge(vtkIdType u, vtkIdType v, vtkVariantArray *propertyArr=nullptr)
Adds a directed edge from u to v, where u and v are vertex indices.
vtkIdType AddVertex(vtkVariantArray *propertyArr)
Adds a vertex to the graph with associated properties defined in propertyArr and returns the index of...
vtkEdgeType AddEdge(const vtkVariant &u, const vtkVariant &v, vtkVariantArray *propertyArr=nullptr)
Adds a directed edge from u to v, where u and v are vertex pedigree IDs, and returns a vtkEdgeType st...
vtkIdType AddChild(vtkIdType parent, vtkVariantArray *propertyArr)
Convenience method for creating trees.
vtkIdType AddChild(vtkIdType parent)
void LazyAddEdge(vtkIdType u, const vtkVariant &v, vtkVariantArray *propertyArr=nullptr)
Adds a directed edge from u to v, where u is a vertex index and v is a vertex pedigree ID.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkIdType AddVertex(const vtkVariant &pedigreeId)
Adds a vertex with the given pedigreeID to the graph and returns the index of the new vertex.
vtkGraphEdge * AddGraphEdge(vtkIdType u, vtkIdType v)
Variant of AddEdge() that returns a heavyweight vtkGraphEdge object.
void LazyAddEdge(const vtkVariant &u, const vtkVariant &v, vtkVariantArray *propertyArr=nullptr)
Adds a directed edge from u to v, where u and v are vertex pedigree IDs.
~vtkMutableDirectedGraph() override
void LazyAddVertex(vtkVariantArray *propertyArr)
Adds a vertex to the graph with associated properties defined in propertyArr.
vtkEdgeType AddEdge(vtkIdType u, vtkIdType v, vtkVariantArray *propertyArr)
Adds a directed edge from u to v, where u and v are vertex indices, with associated properties define...
vtkIdType AddVertex()
Adds a vertex to the graph and returns the index of the new vertex.
vtkEdgeType AddEdge(vtkIdType u, const vtkVariant &v, vtkVariantArray *propertyArr=nullptr)
Adds a directed edge from u to v, where u is a vertex index and v is a vertex pedigree ID,...
void LazyAddVertex(const vtkVariant &pedigreeId)
Adds a vertex with the given pedigreeID to the graph.
void RemoveVertices(vtkIdTypeArray *arr)
Removes a collection of vertices from the graph along with any connected edges.
void RemoveVertex(vtkIdType v)
Removes the vertex from the graph along with any connected edges.
vtkEdgeType AddEdge(const vtkVariant &u, vtkIdType v, vtkVariantArray *propertyArr=nullptr)
Adds a directed edge from u to v, where u is a vertex pedigree ID and v is a vertex index,...
vtkEdgeType AddEdge(vtkIdType u, vtkIdType v)
Adds a directed edge from u to v, where u and v are vertex indices, and returns a vtkEdgeType structu...
virtual vtkIdType SetNumberOfVertices(vtkIdType numVerts)
Allocates space for the specified number of vertices in the graph's internal data structures.
void LazyAddEdge(const vtkVariant &u, vtkIdType v, vtkVariantArray *propertyArr=nullptr)
Adds a directed edge from u to v, where u is a vertex pedigree ID and v is a vertex index.
void LazyAddVertex()
Adds a vertex to the graph.
An array holding vtkVariants.
A type representing the union of many types.
Definition: vtkVariant.h:162
int vtkIdType
Definition: vtkType.h:315