VTK  9.0.1
vtkBoostPrimMinimumSpanningTree.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3 Program: Visualization Toolkit
4 Module: vtkBoostPrimMinimumSpanningTree.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  -------------------------------------------------------------------------*/
46 #ifndef vtkBoostPrimMinimumSpanningTree_h
47 #define vtkBoostPrimMinimumSpanningTree_h
48 
49 #include "vtkInfovisBoostGraphAlgorithmsModule.h" // For export macro
50 #include "vtkStdString.h" // For string type
51 #include "vtkVariant.h" // For variant type
52 
53 #include "vtkTreeAlgorithm.h"
54 
55 class VTKINFOVISBOOSTGRAPHALGORITHMS_EXPORT vtkBoostPrimMinimumSpanningTree
56  : public vtkTreeAlgorithm
57 {
58 public:
61  void PrintSelf(ostream& os, vtkIndent indent) override;
62 
64 
71  vtkSetStringMacro(EdgeWeightArrayName);
73 
79 
88 
90 
94  vtkSetMacro(CreateGraphVertexIdArray, bool);
95  vtkGetMacro(CreateGraphVertexIdArray, bool);
96  vtkBooleanMacro(CreateGraphVertexIdArray, bool);
98 
100 
108  vtkGetMacro(NegateEdgeWeights, bool);
109  vtkBooleanMacro(NegateEdgeWeights, bool);
111 
112 protected:
115 
117 
119 
120 private:
121  char* EdgeWeightArrayName;
122  vtkIdType OriginVertexIndex;
123  vtkVariant OriginValue;
124  bool CreateGraphVertexIdArray;
125  bool ArrayNameSet;
126  char* ArrayName;
127  bool NegateEdgeWeights;
128  float EdgeWeightMultiplier;
129 
131 
134  vtkSetStringMacro(ArrayName);
136 
141  vtkIdType GetVertexIndex(vtkAbstractArray* abstract, vtkVariant value);
142 
144  void operator=(const vtkBoostPrimMinimumSpanningTree&) = delete;
145 };
146 
147 #endif
Abstract superclass for all arrays.
Constructs a minimum spanning tree from a graph, start node, and the weighting array.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
static vtkBoostPrimMinimumSpanningTree * New()
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetNegateEdgeWeights(bool value)
Whether to negate the edge weights.
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
void SetOriginVertex(vtkIdType index)
Set the index (into the vertex array) of the minimum spanning tree 'origin' vertex.
void SetOriginVertex(vtkStdString arrayName, vtkVariant value)
Set the minimum spanning tree 'origin' vertex.
a simple class to control print indentation
Definition: vtkIndent.h:34
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:35
Superclass for algorithms that produce only Tree as output.
A atomic type representing the union of many types.
Definition: vtkVariant.h:66
@ info
Definition: vtkX3D.h:382
@ value
Definition: vtkX3D.h:226
@ port
Definition: vtkX3D.h:453
@ index
Definition: vtkX3D.h:252
int vtkIdType
Definition: vtkType.h:338