VTK  9.2.6
vtkBoostBreadthFirstSearch.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkBoostBreadthFirstSearch.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 -------------------------------------------------------------------------*/
37 #ifndef vtkBoostBreadthFirstSearch_h
38 #define vtkBoostBreadthFirstSearch_h
39 
40 #include "vtkInfovisBoostGraphAlgorithmsModule.h" // For export macro
41 #include "vtkStdString.h" // For string type
42 #include "vtkVariant.h" // For variant type
43 
44 #include "vtkGraphAlgorithm.h"
45 
46 class vtkSelection;
47 
48 class VTKINFOVISBOOSTGRAPHALGORITHMS_EXPORT vtkBoostBreadthFirstSearch : public vtkGraphAlgorithm
49 {
50 public:
53  void PrintSelf(ostream& os, vtkIndent indent) override;
54 
56 
59  void SetOriginSelection(vtkSelection* s);
61  {
62  this->SetInputConnection(1, algOutput);
63  }
65 
70  void SetOriginVertex(vtkIdType index);
71 
79  void SetOriginVertex(vtkStdString arrayName, vtkVariant value);
80 
88  void SetOriginVertexString(char* arrayName, char* value);
89 
91 
95  vtkSetStringMacro(OutputArrayName);
97 
99 
105  vtkSetMacro(OriginFromSelection, bool);
106  vtkGetMacro(OriginFromSelection, bool);
107  vtkBooleanMacro(OriginFromSelection, bool);
109 
111 
116  vtkGetMacro(OutputSelection, bool);
117  vtkSetMacro(OutputSelection, bool);
118  vtkBooleanMacro(OutputSelection, bool);
120 
122 
127  vtkSetStringMacro(OutputSelectionType);
129 
130 protected:
132  ~vtkBoostBreadthFirstSearch() override;
133 
135 
136  int FillInputPortInformation(int port, vtkInformation* info) override;
137 
139 
140 private:
141  vtkIdType OriginVertexIndex;
142  char* InputArrayName;
143  char* OutputArrayName;
144  vtkVariant OriginValue;
145  bool OutputSelection;
146  bool OriginFromSelection;
147  char* OutputSelectionType;
148 
150 
153  vtkSetStringMacro(InputArrayName);
155 
160  vtkIdType GetVertexIndex(vtkAbstractArray* abstract, vtkVariant value);
161 
163  void operator=(const vtkBoostBreadthFirstSearch&) = delete;
164 };
165 
166 #endif
static vtkGraphAlgorithm * New()
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:38
Boost breadth_first_search on a vtkGraph.
Store vtkAlgorithm input/output information.
Abstract superclass for all arrays.
data object that represents a "selection" in VTK.
Definition: vtkSelection.h:59
int vtkIdType
Definition: vtkType.h:332
Superclass for algorithms that produce only graph as output.
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
A atomic type representing the union of many types.
Definition: vtkVariant.h:69
Proxy object to connect input/output ports.
void SetOriginSelectionConnection(vtkAlgorithmOutput *algOutput)
Convenience methods for setting the origin selection input.
a simple class to control print indentation
Definition: vtkIndent.h:39
int FillOutputPortInformation(int port, vtkInformation *info) override
Fill the output port information objects for this algorithm.
virtual void SetInputConnection(int port, vtkAlgorithmOutput *input)
Set the connection for the given input port index.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
This is called by the superclass.
Store zero or more vtkInformation instances.