VTK  9.3.1
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 
57  void SetSourceData(vtkDataObject* source);
58  vtkDataObject* GetSource();
60 
62 
68  void SetSourceConnection(vtkAlgorithmOutput* algOutput);
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:
121  vtkmProbe();
122  ~vtkmProbe() override = default;
123 
129 
131 
133 
135 
140  void PassAttributeData(vtkDataSet* input, vtkDataObject* source, vtkDataSet* output);
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
Sample data at specified point locations.
Definition: vtkmProbe.h:43
vtkTypeBool PassFieldArrays
Definition: vtkmProbe.h:126
Store vtkAlgorithm input/output information.
abstract class to specify dataset behavior
Definition: vtkDataSet.h:52
vtkTypeBool PassPointArrays
Definition: vtkmProbe.h:125
std::string ValidCellMaskArrayName
Definition: vtkmProbe.h:128
Proxy object to connect input/output ports.
int vtkTypeBool
Definition: vtkABI.h:64
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
a simple class to control print indentation
Definition: vtkIndent.h:28
virtual int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called within ProcessRequest when a request asks the algorithm to do its work.
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
vtkTypeBool PassCellArrays
Definition: vtkmProbe.h:124
virtual int RequestUpdateExtent(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called within ProcessRequest when each filter in the pipeline decides what portion of its inp...
virtual int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called within ProcessRequest when a request asks for Information.
std::string ValidPointMaskArrayName
Definition: vtkmProbe.h:127
Store zero or more vtkInformation instances.
Superclass for algorithms that produce output of the same type as input.
general representation of visualization data
Definition: vtkDataObject.h:54
static vtkDataSetAlgorithm * New()