VTK  9.0.3
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 
69 
71 
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:
131  ~vtkmProbe() override = default;
132 
138 
140 
141  virtual int RequestUpdateExtent(
143 
144  virtual int RequestInformation(
146 
152 
153 private:
154  vtkmProbe(const vtkmProbe&) = delete;
155  void operator=(const vtkmProbe&) = delete;
156 };
157 
158 #endif // vtkmProbe_h
159 // VTK-HeaderTest-Exclude: vtkmProbe.h
Proxy object to connect input/output ports.
general representation of visualization data
Definition: vtkDataObject.h:60
Superclass for algorithms that produce output of the same type as input.
abstract class to specify dataset behavior
Definition: vtkDataSet.h:57
a simple class to control print indentation
Definition: vtkIndent.h:34
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Sample data at specified point locations.
Definition: vtkmProbe.h:53
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkTypeBool PassPointArrays
Definition: vtkmProbe.h:134
virtual int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when a request asks the algorithm to do its work.
~vtkmProbe() override=default
void SetSourceConnection(vtkAlgorithmOutput *algOutput)
Specify the data set that will be probed at the input points.
virtual int RequestUpdateExtent(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when each filter in the pipeline decides what portion of its inp...
std::string ValidCellMaskArrayName
Definition: vtkmProbe.h:137
vtkTypeBool PassFieldArrays
Definition: vtkmProbe.h:135
std::string ValidPointMaskArrayName
Definition: vtkmProbe.h:136
void PassAttributeData(vtkDataSet *input, vtkDataObject *source, vtkDataSet *output)
Call at the end of RequestData() to pass attribute dat a respecting the PassCellArrays,...
virtual int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when a request asks for Information.
vtkDataObject * GetSource()
vtkTypeBool PassCellArrays
Definition: vtkmProbe.h:133
static vtkmProbe * New()
void SetSourceData(vtkDataObject *source)
Specify the data set that will be probed at the input points.
@ string
Definition: vtkX3D.h:496
int vtkTypeBool
Definition: vtkABI.h:69
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)