forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkBoostBreadthFirstSearchTree.h
121 lines (100 loc) · 3.66 KB
/
vtkBoostBreadthFirstSearchTree.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
/*=========================================================================
Program: Visualization Toolkit
Module: vtkBoostBreadthFirstSearchTree.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/*-------------------------------------------------------------------------
Copyright 2008 Sandia Corporation.
Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
/**
* @class vtkBoostBreadthFirstSearchTree
* @brief Contructs a BFS tree from a graph
*
*
*
* This vtk class uses the Boost breadth_first_search
* generic algorithm to perform a breadth first search from a given
* a 'source' vertex on the input graph (a vtkGraph).
* The result is a tree with root node corresponding to the start node
* of the search.
*
* @sa
* vtkGraph vtkBoostGraphAdapter
*/
#ifndef vtkBoostBreadthFirstSearchTree_h
#define vtkBoostBreadthFirstSearchTree_h
#include "vtkInfovisBoostGraphAlgorithmsModule.h" // For export macro
#include "vtkStdString.h" // For string type
#include "vtkVariant.h" // For variant type
#include "vtkTreeAlgorithm.h"
class VTKINFOVISBOOSTGRAPHALGORITHMS_EXPORT vtkBoostBreadthFirstSearchTree : public vtkTreeAlgorithm
{
public:
static vtkBoostBreadthFirstSearchTree *New();
vtkTypeMacro(vtkBoostBreadthFirstSearchTree, vtkTreeAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent);
/**
* Set the index (into the vertex array) of the
* breadth first search 'origin' vertex.
*/
void SetOriginVertex(vtkIdType index);
/**
* Set the breadth first search 'origin' vertex.
* This method is basically the same as above
* but allows the application to simply specify
* an array name and value, instead of having to
* know the specific index of the vertex.
*/
void SetOriginVertex(vtkStdString arrayName, vtkVariant value);
//@{
/**
* Stores the graph vertex ids for the tree vertices in an array
* named "GraphVertexId". Default is off.
*/
vtkSetMacro(CreateGraphVertexIdArray, bool);
vtkGetMacro(CreateGraphVertexIdArray, bool);
vtkBooleanMacro(CreateGraphVertexIdArray, bool);
//@}
//@{
/**
* Turn on this option to reverse the edges in the graph.
*/
vtkSetMacro(ReverseEdges, bool);
vtkGetMacro(ReverseEdges, bool);
vtkBooleanMacro(ReverseEdges, bool);
//@}
protected:
vtkBoostBreadthFirstSearchTree();
~vtkBoostBreadthFirstSearchTree();
int FillInputPortInformation(int port, vtkInformation* info);
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *);
private:
vtkIdType OriginVertexIndex;
char* ArrayName;
vtkVariant OriginValue;
bool ArrayNameSet;
bool CreateGraphVertexIdArray;
bool ReverseEdges;
//@{
/**
* Using the convenience function for set strings internally
*/
vtkSetStringMacro(ArrayName);
//@}
/**
* This method is basically a helper function to find
* the index of a specific value within a specific array
*/
vtkIdType GetVertexIndex(
vtkAbstractArray *abstract,vtkVariant value);
vtkBoostBreadthFirstSearchTree(const vtkBoostBreadthFirstSearchTree&) VTK_DELETE_FUNCTION;
void operator=(const vtkBoostBreadthFirstSearchTree&) VTK_DELETE_FUNCTION;
};
#endif