VTK  9.2.6
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
45class VTKINFOVISBOOSTGRAPHALGORITHMS_EXPORT vtkBoostBreadthFirstSearchTree : public vtkTreeAlgorithm
46{
47public:
50 void PrintSelf(ostream& os, vtkIndent indent) override;
51
57
65 void SetOriginVertex(vtkStdString arrayName, vtkVariant value);
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
86protected:
89
90 int FillInputPortInformation(int port, vtkInformation* info) override;
91
93
94private:
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
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:34
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Wrapper around std::string to keep symbols short.
Superclass for algorithms that produce only Tree as output.
A atomic type representing the union of many types.
Definition vtkVariant.h:64
int vtkIdType
Definition vtkType.h:332