VTK  9.2.6
vtkUndirectedGraph.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkUndirectedGraph.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 /*-------------------------------------------------------------------------
16  Copyright 2008 Sandia Corporation.
17  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
18  the U.S. Government retains certain rights in this software.
19 -------------------------------------------------------------------------*/
48 #ifndef vtkUndirectedGraph_h
49 #define vtkUndirectedGraph_h
50 
51 #include "vtkCommonDataModelModule.h" // For export macro
52 #include "vtkGraph.h"
53 
54 class VTKCOMMONDATAMODEL_EXPORT vtkUndirectedGraph : public vtkGraph
55 {
56 public:
57  static vtkUndirectedGraph* New();
58  vtkTypeMacro(vtkUndirectedGraph, vtkGraph);
59  void PrintSelf(ostream& os, vtkIndent indent) override;
60 
64  int GetDataObjectType() override { return VTK_UNDIRECTED_GRAPH; }
65 
69  vtkIdType GetInDegree(vtkIdType v) override;
70 
76 
83  void GetInEdge(vtkIdType v, vtkIdType i, vtkGraphEdge* e) override
84  {
85  this->Superclass::GetInEdge(v, i, e);
86  }
87 
89 
93  static vtkUndirectedGraph* GetData(vtkInformationVector* v, int i = 0);
95 
100  void GetInEdges(vtkIdType v, vtkInEdgeIterator* it) override { Superclass::GetInEdges(v, it); }
101 
107  bool IsStructureValid(vtkGraph* g) override;
108 
109 protected:
111  ~vtkUndirectedGraph() override;
112 
116  void GetInEdges(vtkIdType v, const vtkInEdgeType*& edges, vtkIdType& nedges) override;
117 
118 private:
119  vtkUndirectedGraph(const vtkUndirectedGraph&) = delete;
120  void operator=(const vtkUndirectedGraph&) = delete;
121 };
122 
123 #endif
static vtkDataObject * New()
Store vtkAlgorithm input/output information.
#define VTK_UNDIRECTED_GRAPH
Definition: vtkType.h:101
An undirected graph.
Representation of a single graph edge.
Definition: vtkGraphEdge.h:39
static vtkGraph * GetData(vtkInformation *info)
Retrieve a graph from an information vector.
int vtkIdType
Definition: vtkType.h:332
virtual void GetInEdges(vtkIdType v, vtkInEdgeIterator *it)
Initializes the in edge iterator to iterate over all incoming edges to vertex v.
void GetInEdges(vtkIdType v, vtkInEdgeIterator *it) override
Initialize the iterator to get the incoming edges to a vertex.
virtual vtkInEdgeType GetInEdge(vtkIdType v, vtkIdType index)
Random-access method for retrieving incoming edges to vertex v.
Base class for graph data types.
Definition: vtkGraph.h:295
a simple class to control print indentation
Definition: vtkIndent.h:39
int GetDataObjectType() override
Return what type of dataset this is.
Iterates through all incoming edges to a vertex.
virtual vtkIdType GetInDegree(vtkIdType v)
The number of incoming edges to vertex v.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void GetInEdge(vtkIdType v, vtkIdType i, vtkGraphEdge *e) override
Random-access method for retrieving incoming edges to vertex v.
virtual bool IsStructureValid(vtkGraph *g)=0
Subclasses override this method to accept the structure based on their requirements.
Store zero or more vtkInformation instances.
std::pair< boost::graph_traits< vtkGraph * >::edge_iterator, boost::graph_traits< vtkGraph * >::edge_iterator > edges(vtkGraph *g)