VTK  9.3.0
vtkmProbe.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-FileCopyrightText: Copyright (c) Kitware, Inc.
3 // SPDX-FileCopyrightText: Copyright 2012 Sandia Corporation.
4 // SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
33 #ifndef vtkmProbe_h
34 #define vtkmProbe_h
35 
36 #include <string> // for std::string
37 
38 #include "vtkAcceleratorsVTKmFiltersModule.h" //required for export
39 #include "vtkDataSetAlgorithm.h"
40 #include "vtkmlib/vtkmInitializer.h" // Need for initializing vtk-m
41 
42 VTK_ABI_NAMESPACE_BEGIN
43 class VTKACCELERATORSVTKMFILTERS_EXPORT vtkmProbe : public vtkDataSetAlgorithm
44 {
45 public:
47  void PrintSelf(ostream& os, vtkIndent indent) override;
48  static vtkmProbe* New();
49 
51 
60 
62 
70 
72 
76  vtkSetMacro(PassCellArrays, vtkTypeBool);
77  vtkBooleanMacro(PassCellArrays, vtkTypeBool);
78  vtkGetMacro(PassCellArrays, vtkTypeBool);
81 
85  vtkSetMacro(PassPointArrays, vtkTypeBool);
86  vtkBooleanMacro(PassPointArrays, vtkTypeBool);
87  vtkGetMacro(PassPointArrays, vtkTypeBool);
89 
91 
95  vtkSetMacro(PassFieldArrays, vtkTypeBool);
96  vtkBooleanMacro(PassFieldArrays, vtkTypeBool);
97  vtkGetMacro(PassFieldArrays, vtkTypeBool);
99 
101 
106  vtkSetMacro(ValidPointMaskArrayName, std::string);
107  vtkGetMacro(ValidPointMaskArrayName, std::string);
109 
111 
116  vtkSetMacro(ValidCellMaskArrayName, std::string);
117  vtkGetMacro(ValidCellMaskArrayName, std::string);
119 
120 protected:
122  ~vtkmProbe() override = default;
123 
129 
131 
133 
135 
141 
142 private:
143  vtkmProbe(const vtkmProbe&) = delete;
144  void operator=(const vtkmProbe&) = delete;
145  vtkmInitializer Initializer;
146 };
147 
148 VTK_ABI_NAMESPACE_END
149 #endif // vtkmProbe_h
Proxy object to connect input/output ports.
general representation of visualization data
Definition: vtkDataObject.h:55
Superclass for algorithms that produce output of the same type as input.
abstract class to specify dataset behavior
Definition: vtkDataSet.h:53
a simple class to control print indentation
Definition: vtkIndent.h:29
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Sample data at specified point locations.
Definition: vtkmProbe.h:44
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int RequestUpdateExtent(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when each filter in the pipeline decides what portion of its inp...
vtkTypeBool PassPointArrays
Definition: vtkmProbe.h:125
~vtkmProbe() override=default
void SetSourceConnection(vtkAlgorithmOutput *algOutput)
Specify the data set that will be probed at the input points.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when a request asks the algorithm to do its work.
std::string ValidCellMaskArrayName
Definition: vtkmProbe.h:128
vtkTypeBool PassFieldArrays
Definition: vtkmProbe.h:126
std::string ValidPointMaskArrayName
Definition: vtkmProbe.h:127
void PassAttributeData(vtkDataSet *input, vtkDataObject *source, vtkDataSet *output)
Call at the end of RequestData() to pass attribute dat a respecting the PassCellArrays,...
vtkDataObject * GetSource()
Specify the data set that will be probed at the input points.
vtkTypeBool PassCellArrays
Definition: vtkmProbe.h:124
static vtkmProbe * New()
void SetSourceData(vtkDataObject *source)
Specify the data set that will be probed at the input points.
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when a request asks for Information.
@ string
Definition: vtkX3D.h:490
int vtkTypeBool
Definition: vtkABI.h:64
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)