VTK  9.3.0
vtkBoostBreadthFirstSearchTree.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
32 #ifndef vtkBoostBreadthFirstSearchTree_h
33 #define vtkBoostBreadthFirstSearchTree_h
34 
35 #include "vtkInfovisBoostGraphAlgorithmsModule.h" // For export macro
36 #include "vtkStdString.h" // For string type
37 #include "vtkVariant.h" // For variant type
38 
39 #include "vtkTreeAlgorithm.h"
40 
41 VTK_ABI_NAMESPACE_BEGIN
42 class VTKINFOVISBOOSTGRAPHALGORITHMS_EXPORT vtkBoostBreadthFirstSearchTree : public vtkTreeAlgorithm
43 {
44 public:
47  void PrintSelf(ostream& os, vtkIndent indent) override;
48 
54 
63 
65 
69  vtkSetMacro(CreateGraphVertexIdArray, bool);
70  vtkGetMacro(CreateGraphVertexIdArray, bool);
71  vtkBooleanMacro(CreateGraphVertexIdArray, bool);
73 
75 
78  vtkSetMacro(ReverseEdges, bool);
79  vtkGetMacro(ReverseEdges, bool);
80  vtkBooleanMacro(ReverseEdges, bool);
82 
83 protected:
86 
88 
90 
91 private:
92  vtkIdType OriginVertexIndex;
93  char* ArrayName;
94  vtkVariant OriginValue;
95  bool ArrayNameSet;
96  bool CreateGraphVertexIdArray;
97  bool ReverseEdges;
98 
100 
103  vtkSetStringMacro(ArrayName);
105 
110  vtkIdType GetVertexIndex(vtkAbstractArray* abstract, vtkVariant value);
111 
113  void operator=(const vtkBoostBreadthFirstSearchTree&) = delete;
114 };
115 
116 VTK_ABI_NAMESPACE_END
117 #endif
Abstract superclass for all arrays.
Constructs a BFS tree from a graph.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
void SetOriginVertex(vtkStdString arrayName, vtkVariant value)
Set the breadth first search 'origin' vertex.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
static vtkBoostBreadthFirstSearchTree * New()
~vtkBoostBreadthFirstSearchTree() override
void SetOriginVertex(vtkIdType index)
Set the index (into the vertex array) of the breadth first search 'origin' vertex.
a simple class to control print indentation
Definition: vtkIndent.h:38
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:38
Superclass for algorithms that produce only Tree as output.
A type representing the union of many types.
Definition: vtkVariant.h:62
@ info
Definition: vtkX3D.h:376
@ value
Definition: vtkX3D.h:220
@ port
Definition: vtkX3D.h:447
@ index
Definition: vtkX3D.h:246
int vtkIdType
Definition: vtkType.h:315