VTK
vtkPBGLRandomGraphSource.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPBGLRandomGraphSource.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 -------------------------------------------------------------------------*/
42 #ifndef vtkPBGLRandomGraphSource_h
43 #define vtkPBGLRandomGraphSource_h
44 
45 #include "vtkInfovisParallelModule.h" // For export macro
46 #include "vtkGraphAlgorithm.h"
47 
48 class vtkGraph;
49 class vtkPVXMLElement;
50 
51 #if !defined(VTK_LEGACY_REMOVE)
52 class VTKINFOVISPARALLEL_EXPORT vtkPBGLRandomGraphSource : public vtkGraphAlgorithm
53 {
54 public:
55  static vtkPBGLRandomGraphSource* New();
57  void PrintSelf(ostream& os, vtkIndent indent);
58 
60 
63  vtkGetMacro(NumberOfVertices, vtkIdType);
64  vtkSetClampMacro(NumberOfVertices, vtkIdType, 0, VTK_ID_MAX);
66 
68 
72  vtkGetMacro(NumberOfEdges, vtkIdType);
73  vtkSetClampMacro(NumberOfEdges, vtkIdType, 0, VTK_ID_MAX);
75 
77 
81  vtkGetMacro(EdgeProbability, double);
82  vtkSetClampMacro(EdgeProbability, double, 0.0, 1.0);
84 
86 
90  vtkSetMacro(IncludeEdgeWeights, bool);
91  vtkGetMacro(IncludeEdgeWeights, bool);
92  vtkBooleanMacro(IncludeEdgeWeights, bool);
94 
96 
99  vtkSetStringMacro(EdgeWeightArrayName);
100  vtkGetStringMacro(EdgeWeightArrayName);
102 
104 
107  vtkSetMacro(Directed, bool);
108  vtkGetMacro(Directed, bool);
109  vtkBooleanMacro(Directed, bool);
111 
113 
121  vtkSetMacro(UseEdgeProbability, bool);
122  vtkGetMacro(UseEdgeProbability, bool);
123  vtkBooleanMacro(UseEdgeProbability, bool);
125 
127 
131  vtkSetMacro(StartWithTree, bool);
132  vtkGetMacro(StartWithTree, bool);
133  vtkBooleanMacro(StartWithTree, bool);
135 
137 
142  vtkSetMacro(AllowSelfLoops, bool);
143  vtkGetMacro(AllowSelfLoops, bool);
144  vtkBooleanMacro(AllowSelfLoops, bool);
146 
148 
155  vtkSetMacro(AllowBalancedEdgeDistribution, bool);
156  vtkGetMacro(AllowBalancedEdgeDistribution, bool);
157  vtkBooleanMacro(AllowBalancedEdgeDistribution, bool);
159 
161 
164  vtkSetMacro(GeneratePedigreeIds, bool);
165  vtkGetMacro(GeneratePedigreeIds, bool);
166  vtkBooleanMacro(GeneratePedigreeIds, bool);
168 
170 
174  vtkSetStringMacro(VertexPedigreeIdArrayName);
175  vtkGetStringMacro(VertexPedigreeIdArrayName);
177 
179 
182  vtkSetStringMacro(EdgePedigreeIdArrayName);
183  vtkGetStringMacro(EdgePedigreeIdArrayName);
185 
187 
192  vtkSetMacro(Seed, int);
193  vtkGetMacro(Seed, int);
195 
196 protected:
202  bool Directed;
209  int Seed;
213 
214  virtual int RequestData(
218 
222  virtual int RequestDataObject(vtkInformation*,
223  vtkInformationVector** inputVector,
224  vtkInformationVector* outputVector);
225 
226 private:
227  vtkPBGLRandomGraphSource(const vtkPBGLRandomGraphSource&) VTK_DELETE_FUNCTION;
228  void operator=(const vtkPBGLRandomGraphSource&) VTK_DELETE_FUNCTION;
229 };
230 
231 #endif //VTK_LEGACY_REMOVE
232 #endif
233 
vtkPBGLRandomGraphSource::UseEdgeProbability
bool UseEdgeProbability
Definition: vtkPBGLRandomGraphSource.h:203
vtkGraphAlgorithm
Superclass for algorithms that produce only graph as output.
Definition: vtkGraphAlgorithm.h:54
vtkPBGLRandomGraphSource::VertexPedigreeIdArrayName
char * VertexPedigreeIdArrayName
Definition: vtkPBGLRandomGraphSource.h:211
vtkIdType
int vtkIdType
Definition: vtkType.h:287
vtkPBGLRandomGraphSource::Seed
int Seed
Definition: vtkPBGLRandomGraphSource.h:209
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:41
vtkPBGLRandomGraphSource::IncludeEdgeWeights
bool IncludeEdgeWeights
Definition: vtkPBGLRandomGraphSource.h:205
vtkPBGLRandomGraphSource::AllowBalancedEdgeDistribution
bool AllowBalancedEdgeDistribution
Definition: vtkPBGLRandomGraphSource.h:207
vtkGraphAlgorithm::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkGraphAlgorithm.h
vtkGraphAlgorithm::RequestDataObject
virtual int RequestDataObject(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
vtkPBGLRandomGraphSource::EdgeProbability
double EdgeProbability
Definition: vtkPBGLRandomGraphSource.h:201
vtkPBGLRandomGraphSource::NumberOfEdges
vtkIdType NumberOfEdges
Definition: vtkPBGLRandomGraphSource.h:200
vtkPBGLRandomGraphSource::NumberOfVertices
vtkIdType NumberOfVertices
Definition: vtkPBGLRandomGraphSource.h:199
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkPBGLRandomGraphSource::AllowSelfLoops
bool AllowSelfLoops
Definition: vtkPBGLRandomGraphSource.h:206
vtkPBGLRandomGraphSource::StartWithTree
bool StartWithTree
Definition: vtkPBGLRandomGraphSource.h:204
vtkPBGLRandomGraphSource::EdgeWeightArrayName
char * EdgeWeightArrayName
Definition: vtkPBGLRandomGraphSource.h:210
vtkGetStringMacro
vtkGetStringMacro(ExtensionsString)
Returns a string listing all available extensions.
vtkBooleanMacro
vtkBooleanMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
vtkSetMacro
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkPBGLRandomGraphSource::Directed
bool Directed
Definition: vtkPBGLRandomGraphSource.h:202
vtkGraphAlgorithm::RequestData
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
This is called by the superclass.
vtkPBGLRandomGraphSource
Generates a distributed graph with random edges.
Definition: vtkPBGLRandomGraphSource.h:52
vtkPBGLRandomGraphSource::GeneratePedigreeIds
bool GeneratePedigreeIds
Definition: vtkPBGLRandomGraphSource.h:208
VTK_ID_MAX
#define VTK_ID_MAX
Definition: vtkType.h:291
vtkGraph
Base class for graph data types.
Definition: vtkGraph.h:287
vtkGraphAlgorithm::New
static vtkGraphAlgorithm * New()
vtkPBGLRandomGraphSource::EdgePedigreeIdArrayName
char * EdgePedigreeIdArrayName
Definition: vtkPBGLRandomGraphSource.h:212