vtkBoostBreadthFirstSearch.h 4.99 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkBoostBreadthFirstSearch.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.

=========================================================================*/
15 16 17 18 19
/*-------------------------------------------------------------------------
  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.
-------------------------------------------------------------------------*/
20 21 22 23 24 25 26 27 28 29 30 31 32
/**
 * @class   vtkBoostBreadthFirstSearch
 * @brief   Boost breadth_first_search on a vtkGraph
 *
 *
 *
 * 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).
 *
 * @sa
 * vtkGraph vtkBoostGraphAdapter
*/
33

34 35
#ifndef vtkBoostBreadthFirstSearch_h
#define vtkBoostBreadthFirstSearch_h
36

37
#include "vtkInfovisBoostGraphAlgorithmsModule.h" // For export macro
38 39 40 41 42
#include "vtkStdString.h" // For string type
#include "vtkVariant.h" // For variant type

#include "vtkGraphAlgorithm.h"

43 44
class vtkSelection;

45
class VTKINFOVISBOOSTGRAPHALGORITHMS_EXPORT vtkBoostBreadthFirstSearch : public vtkGraphAlgorithm
46 47 48
{
public:
  static vtkBoostBreadthFirstSearch *New();
49
  vtkTypeMacro(vtkBoostBreadthFirstSearch, vtkGraphAlgorithm);
50
  void PrintSelf(ostream& os, vtkIndent indent) override;
51

52 53 54 55
  //@{
  /**
   * Convenience methods for setting the origin selection input.
   */
56 57 58 59 60
  void SetOriginSelection(vtkSelection *s);
  void SetOriginSelectionConnection(vtkAlgorithmOutput* algOutput)
  {
    this->SetInputConnection(1, algOutput);
  }
61
  //@}
62

63 64 65 66
  /**
   * Set the index (into the vertex array) of the
   * breadth first search 'origin' vertex.
   */
67 68
  void SetOriginVertex(vtkIdType index);

69 70 71 72 73 74 75
  /**
   * 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.
   */
76 77
  void SetOriginVertex(vtkStdString arrayName, vtkVariant value);

78 79 80 81 82 83 84
  /**
   * Convenience method for setting the origin vertex
   * given an array name and string value.
   * This method is primarily for the benefit of the
   * VTK Parallel client/server layer, callers should
   * prefer to use SetOriginVertex() whenever possible.
   */
85 86
  void SetOriginVertexString(char* arrayName, char* value);

87 88 89 90 91
  //@{
  /**
   * Set the output array name. If no output array name is
   * set then the name 'BFS' is used.
   */
92
  vtkSetStringMacro(OutputArrayName);
93 94 95 96 97 98 99 100 101
  //@}

  //@{
  /**
   * Use the vtkSelection from input port 1 as the origin vertex.
   * The selection should be a IDS selection with field type POINTS.
   * The first ID in the selection will be used for the origin vertex.
   * Default is off (origin is specified by SetOriginVertex(...)).
   */
102 103 104
  vtkSetMacro(OriginFromSelection, bool);
  vtkGetMacro(OriginFromSelection, bool);
  vtkBooleanMacro(OriginFromSelection, bool);
105 106 107 108 109 110 111 112
  //@}

  //@{
  /**
   * Create an output selection containing the ID of a vertex based
   * on the output selection type. The default is to use the
   * the maximum distance from the starting vertex.  Defaults to off.
   */
113 114 115
  vtkGetMacro(OutputSelection, bool);
  vtkSetMacro(OutputSelection, bool);
  vtkBooleanMacro(OutputSelection, bool);
116 117 118 119 120 121 122 123
  //@}

  //@{
  /**
   * Set the output selection type. The default is to use the
   * the maximum distance from the starting vertex "MAX_DIST_FROM_ROOT".
   * But you can also specify other things like "ROOT","2D_MAX", etc
   */
124
  vtkSetStringMacro(OutputSelectionType);
125
  //@}
126 127 128 129 130 131

protected:
  vtkBoostBreadthFirstSearch();
  ~vtkBoostBreadthFirstSearch();

  virtual int RequestData(
132 133
    vtkInformation *,
    vtkInformationVector **,
134
    vtkInformationVector *) override;
135 136

  virtual int FillInputPortInformation(
137
    int port, vtkInformation* info) override;
138 139

  virtual int FillOutputPortInformation(
140
    int port, vtkInformation* info) override;
141

142 143 144 145 146 147 148 149 150
private:

  vtkIdType OriginVertexIndex;
  char* InputArrayName;
  char* OutputArrayName;
  vtkVariant OriginValue;
  bool OutputSelection;
  bool OriginFromSelection;
  char* OutputSelectionType;
151

152 153 154 155
  //@{
  /**
   * Using the convenience function internally
   */
156
  vtkSetStringMacro(InputArrayName);
157
  //@}
158

159 160 161 162
  /**
   * This method is basically a helper function to find
   * the index of a specific value within a specific array
   */
163
  vtkIdType GetVertexIndex(
164 165
    vtkAbstractArray *abstract,vtkVariant value);

166 167
  vtkBoostBreadthFirstSearch(const vtkBoostBreadthFirstSearch&) = delete;
  void operator=(const vtkBoostBreadthFirstSearch&) = delete;
168 169 170
};

#endif