VTK  9.1.0
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-------------------------------------------------------------------------*/
55#ifndef vtkBoostBreadthFirstSearchTree_h
56#define vtkBoostBreadthFirstSearchTree_h
57
58#include "vtkInfovisBoostGraphAlgorithmsModule.h" // For export macro
59#include "vtkStdString.h" // For string type
60#include "vtkVariant.h" // For variant type
61
62#include "vtkTreeAlgorithm.h"
63
64class VTKINFOVISBOOSTGRAPHALGORITHMS_EXPORT vtkBoostBreadthFirstSearchTree : public vtkTreeAlgorithm
65{
66public:
69 void PrintSelf(ostream& os, vtkIndent indent) override;
70
76
84 void SetOriginVertex(vtkStdString arrayName, vtkVariant value);
85
87
91 vtkSetMacro(CreateGraphVertexIdArray, bool);
92 vtkGetMacro(CreateGraphVertexIdArray, bool);
93 vtkBooleanMacro(CreateGraphVertexIdArray, bool);
95
97
100 vtkSetMacro(ReverseEdges, bool);
101 vtkGetMacro(ReverseEdges, bool);
102 vtkBooleanMacro(ReverseEdges, bool);
104
105protected:
108
109 int FillInputPortInformation(int port, vtkInformation* info) override;
110
112
113private:
114 vtkIdType OriginVertexIndex;
115 char* ArrayName;
116 vtkVariant OriginValue;
117 bool ArrayNameSet;
118 bool CreateGraphVertexIdArray;
119 bool ReverseEdges;
120
122
125 vtkSetStringMacro(ArrayName);
127
132 vtkIdType GetVertexIndex(vtkAbstractArray* abstract, vtkVariant value);
133
135 void operator=(const vtkBoostBreadthFirstSearchTree&) = delete;
136};
137
138#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:113
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:105
Superclass for algorithms that produce only Tree as output.
A atomic type representing the union of many types.
Definition: vtkVariant.h:145
int vtkIdType
Definition: vtkType.h:332