VTK  9.0.20210518
vtkBoostBreadthFirstSearchTree.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkBoostBreadthFirstSearchTree.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 -------------------------------------------------------------------------*/
36 #ifndef vtkBoostBreadthFirstSearchTree_h
37 #define vtkBoostBreadthFirstSearchTree_h
38 
39 #include "vtkInfovisBoostGraphAlgorithmsModule.h" // For export macro
40 #include "vtkStdString.h" // For string type
41 #include "vtkVariant.h" // For variant type
42 
43 #include "vtkTreeAlgorithm.h"
44 
45 class VTKINFOVISBOOSTGRAPHALGORITHMS_EXPORT vtkBoostBreadthFirstSearchTree : public vtkTreeAlgorithm
46 {
47 public:
50  void PrintSelf(ostream& os, vtkIndent indent) override;
51 
57 
66 
68 
72  vtkSetMacro(CreateGraphVertexIdArray, bool);
73  vtkGetMacro(CreateGraphVertexIdArray, bool);
74  vtkBooleanMacro(CreateGraphVertexIdArray, bool);
76 
78 
81  vtkSetMacro(ReverseEdges, bool);
82  vtkGetMacro(ReverseEdges, bool);
83  vtkBooleanMacro(ReverseEdges, bool);
85 
86 protected:
89 
91 
93 
94 private:
95  vtkIdType OriginVertexIndex;
96  char* ArrayName;
97  vtkVariant OriginValue;
98  bool ArrayNameSet;
99  bool CreateGraphVertexIdArray;
100  bool ReverseEdges;
101 
103 
106  vtkSetStringMacro(ArrayName);
108 
113  vtkIdType GetVertexIndex(vtkAbstractArray* abstract, vtkVariant value);
114 
116  void operator=(const vtkBoostBreadthFirstSearchTree&) = delete;
117 };
118 
119 #endif
vtkStdString.h
vtkVariant.h
vtkX3D::value
@ value
Definition: vtkX3D.h:226
vtkIdType
int vtkIdType
Definition: vtkType.h:332
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:36
vtkTreeAlgorithm.h
vtkBoostBreadthFirstSearchTree::~vtkBoostBreadthFirstSearchTree
~vtkBoostBreadthFirstSearchTree() override
vtkBoostBreadthFirstSearchTree::New
static vtkBoostBreadthFirstSearchTree * New()
vtkX3D::port
@ port
Definition: vtkX3D.h:453
vtkBoostBreadthFirstSearchTree::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkBoostBreadthFirstSearchTree::SetOriginVertex
void SetOriginVertex(vtkIdType index)
Set the index (into the vertex array) of the breadth first search 'origin' vertex.
vtkBoostBreadthFirstSearchTree::vtkBoostBreadthFirstSearchTree
vtkBoostBreadthFirstSearchTree()
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:34
vtkVariant
A atomic type representing the union of many types.
Definition: vtkVariant.h:66
vtkTreeAlgorithm
Superclass for algorithms that produce only Tree as output.
Definition: vtkTreeAlgorithm.h:46
vtkAbstractArray
Abstract superclass for all arrays.
Definition: vtkAbstractArray.h:76
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:74
vtkX3D::info
@ info
Definition: vtkX3D.h:382
vtkBoostBreadthFirstSearchTree
Constructs a BFS tree from a graph.
Definition: vtkBoostBreadthFirstSearchTree.h:46
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:36
vtkBoostBreadthFirstSearchTree::RequestData
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
vtkBoostBreadthFirstSearchTree::FillInputPortInformation
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
vtkBoostBreadthFirstSearchTree::SetOriginVertex
void SetOriginVertex(vtkStdString arrayName, vtkVariant value)
Set the breadth first search 'origin' vertex.
vtkX3D::index
@ index
Definition: vtkX3D.h:252