VTK
vtkmProbe.h
Go to the documentation of this file.
1 //=============================================================================
2 //
3 // Copyright (c) Kitware, Inc.
4 // All rights reserved.
5 // See LICENSE.txt for details.
6 //
7 // This software is distributed WITHOUT ANY WARRANTY; without even
8 // the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
9 // PURPOSE. See the above copyright notice for more information.
10 //
11 // Copyright 2012 Sandia Corporation.
12 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
13 // the U.S. Government retains certain rights in this software.
14 //
15 //=============================================================================
44 #ifndef vtkmProbe_h
45 #define vtkmProbe_h
46 
47 #include <string> // for std::string
48 
49 #include "vtkAcceleratorsVTKmModule.h" //required for export
50 #include "vtkDataSetAlgorithm.h"
51 
52 class VTKACCELERATORSVTKM_EXPORT vtkmProbe : public vtkDataSetAlgorithm
53 {
54 public:
56  void PrintSelf(ostream& os, vtkIndent indent) override;
57  static vtkmProbe* New();
58 
60 
66  void SetSourceData(vtkDataObject *source);
67  vtkDataObject *GetSource();
69 
71 
77  void SetSourceConnection(vtkAlgorithmOutput* algOutput);
79 
81 
85  vtkSetMacro(PassCellArrays, vtkTypeBool);
86  vtkBooleanMacro(PassCellArrays, vtkTypeBool);
87  vtkGetMacro(PassCellArrays, vtkTypeBool);
89 
90 
94  vtkSetMacro(PassPointArrays, vtkTypeBool);
95  vtkBooleanMacro(PassPointArrays, vtkTypeBool);
96  vtkGetMacro(PassPointArrays, vtkTypeBool);
98 
100 
104  vtkSetMacro(PassFieldArrays, vtkTypeBool);
105  vtkBooleanMacro(PassFieldArrays, vtkTypeBool);
106  vtkGetMacro(PassFieldArrays, vtkTypeBool);
108 
110 
115  vtkSetMacro(ValidPointMaskArrayName, std::string)
116  vtkGetMacro(ValidPointMaskArrayName, std::string)
118 
120 
125  vtkSetMacro(ValidCellMaskArrayName, std::string)
126  vtkGetMacro(ValidCellMaskArrayName, std::string)
128 
129 protected:
130  vtkmProbe();
131  ~vtkmProbe()=default;
132 
138 
140  vtkInformationVector*) override;
141 
142  virtual int RequestUpdateExtent(vtkInformation*,
144  vtkInformationVector*) override;
145 
146  virtual int RequestInformation(vtkInformation*,
148  vtkInformationVector*) override;
149 
154  void PassAttributeData(vtkDataSet* input, vtkDataObject* source,
155  vtkDataSet* output);
156 
157 private:
158  vtkmProbe(const vtkmProbe&) = delete;
159  void operator=(const vtkmProbe&) = delete;
160 };
161 
162 #endif //vtkmProbe_h
163 // VTK-HeaderTest-Exclude: vtkmProbe.h
vtkmProbe::ValidCellMaskArrayName
std::string ValidCellMaskArrayName
Definition: vtkmProbe.h:137
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:41
vtkmProbe
Sample data at specified point locations.
Definition: vtkmProbe.h:52
vtkDataSetAlgorithm::RequestData
virtual int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called within ProcessRequest when a request asks the algorithm to do its work.
Definition: vtkDataSetAlgorithm.h:180
vtkmProbe::PassPointArrays
vtkTypeBool PassPointArrays
Definition: vtkmProbe.h:134
source
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition: vtkBoostGraphAdapter.h:825
vtkDataSetAlgorithm
Superclass for algorithms that produce output of the same type as input.
Definition: vtkDataSetAlgorithm.h:48
vtkmProbe::PassFieldArrays
vtkTypeBool PassFieldArrays
Definition: vtkmProbe.h:135
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkDataSetAlgorithm::New
static vtkDataSetAlgorithm * New()
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:62
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
vtkmProbe::ValidPointMaskArrayName
std::string ValidPointMaskArrayName
Definition: vtkmProbe.h:136
vtkX3D::string
Definition: vtkX3D.h:490
vtkDataSetAlgorithm.h
vtkDataSetAlgorithm::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkAlgorithmOutput
Proxy object to connect input/output ports.
Definition: vtkAlgorithmOutput.h:39
vtkDataSetAlgorithm::RequestUpdateExtent
virtual int RequestUpdateExtent(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called within ProcessRequest when each filter in the pipeline decides what portion of its inp...
Definition: vtkDataSetAlgorithm.h:152
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:64
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkmProbe::PassCellArrays
vtkTypeBool PassCellArrays
Definition: vtkmProbe.h:133
vtkDataSetAlgorithm::RequestInformation
virtual int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called within ProcessRequest when a request asks for Information.
Definition: vtkDataSetAlgorithm.h:141