VTK
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 -------------------------------------------------------------------------*/
42 #ifndef vtkBoostBreadthFirstSearchTree_h
43 #define vtkBoostBreadthFirstSearchTree_h
44 
45 #include "vtkInfovisBoostGraphAlgorithmsModule.h" // For export macro
46 #include "vtkStdString.h" // For string type
47 #include "vtkVariant.h" // For variant type
48 
49 #include "vtkTreeAlgorithm.h"
50 
51 class VTKINFOVISBOOSTGRAPHALGORITHMS_EXPORT vtkBoostBreadthFirstSearchTree : public vtkTreeAlgorithm
52 {
53 public:
56  void PrintSelf(ostream& os, vtkIndent indent) override;
57 
62  void SetOriginVertex(vtkIdType index);
63 
71  void SetOriginVertex(vtkStdString arrayName, vtkVariant value);
72 
74 
78  vtkSetMacro(CreateGraphVertexIdArray, bool);
79  vtkGetMacro(CreateGraphVertexIdArray, bool);
80  vtkBooleanMacro(CreateGraphVertexIdArray, bool);
82 
84 
87  vtkSetMacro(ReverseEdges, bool);
88  vtkGetMacro(ReverseEdges, bool);
89  vtkBooleanMacro(ReverseEdges, bool);
91 
92 protected:
95 
97 
99 
100 private:
101 
102  vtkIdType OriginVertexIndex;
103  char* ArrayName;
104  vtkVariant OriginValue;
105  bool ArrayNameSet;
106  bool CreateGraphVertexIdArray;
107  bool ReverseEdges;
108 
110 
113  vtkSetStringMacro(ArrayName);
115 
120  vtkIdType GetVertexIndex(
121  vtkAbstractArray *abstract,vtkVariant value);
122 
124  void operator=(const vtkBoostBreadthFirstSearchTree&) = delete;
125 };
126 
127 #endif
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:40
Superclass for algorithms that produce only Tree as output.
Store vtkAlgorithm input/output information.
Abstract superclass for all arrays.
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
This is called by the superclass.
int vtkIdType
Definition: vtkType.h:347
A atomic type representing the union of many types.
Definition: vtkVariant.h:71
Constructs a BFS tree from a graph.
a simple class to control print indentation
Definition: vtkIndent.h:39
Store zero or more vtkInformation instances.
static vtkTreeAlgorithm * New()
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.