VTK  9.3.0
vtkDemandDrivenPipeline.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
27 #ifndef vtkDemandDrivenPipeline_h
28 #define vtkDemandDrivenPipeline_h
29 
30 #include "vtkCommonExecutionModelModule.h" // For export macro
31 #include "vtkExecutive.h"
32 
33 VTK_ABI_NAMESPACE_BEGIN
34 class vtkAbstractArray;
35 class vtkDataArray;
37 class vtkDemandDrivenPipelineInternals;
38 class vtkFieldData;
39 class vtkInformation;
44 
51 
52 class VTKCOMMONEXECUTIONMODEL_EXPORT vtkDemandDrivenPipeline : public vtkExecutive
53 {
54 public:
57  void PrintSelf(ostream& os, vtkIndent indent) override;
58 
64  vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
65 
70  vtkInformationVector* outInfoVec, int requestFromOutputPort, vtkMTimeType* mtime) override;
71 
73 
77  vtkTypeBool Update() override;
78  vtkTypeBool Update(int port) override;
80 
82 
85  vtkGetMacro(PipelineMTime, vtkMTimeType);
87 
92  virtual int SetReleaseDataFlag(int port, vtkTypeBool n);
93 
98 
102  virtual int UpdatePipelineMTime();
103 
109  int UpdateDataObject() override;
110 
114  int UpdateInformation() override;
115 
121  virtual int UpdateData(int outputPort);
122 
128 
134 
140 
147 
154 
162 
168  static vtkDataObject* NewDataObject(const char* type);
169 
170 protected:
173 
174  // Helper methods to send requests to the algorithm.
175  virtual int ExecuteDataObject(
176  vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
177  virtual int ExecuteInformation(
178  vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
179  virtual int ExecuteData(
180  vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
181 
182  // Reset the pipeline update values in the given output information object.
184 
185  // Check whether the data object in the pipeline information for an
186  // output port exists and has a valid type.
187  virtual int CheckDataObject(int port, vtkInformationVector* outInfo);
188 
189  // Input connection validity checkers.
198 
199  // Field existence checkers.
203 
204  // Input port information checkers.
207 
208  // Decide whether the output data need to be generated.
209  virtual int NeedToExecuteData(
210  int outputPort, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
211 
212  // Handle before/after operations for ExecuteData method.
213  virtual void ExecuteDataStart(
214  vtkInformation* request, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
215  virtual void ExecuteDataEnd(
216  vtkInformation* request, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
217  virtual void MarkOutputsGenerated(
218  vtkInformation* request, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
219 
220  // Largest MTime of any algorithm on this executive or preceding
221  // executives.
223 
224  // Time when information or data were last generated.
228 
230 
234 
235 private:
237  void operator=(const vtkDemandDrivenPipeline&) = delete;
238 };
239 
240 VTK_ABI_NAMESPACE_END
241 #endif
Abstract superclass for all arrays.
Executive supporting composite datasets.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:54
general representation of visualization data
Definition: vtkDataObject.h:64
represent and manipulate attribute data in a dataset
Executive supporting on-demand execution.
void ResetPipelineInformation(int, vtkInformation *) override
int ComputePipelineMTime(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime) override
Implement the pipeline modified time request.
int UpdateInformation() override
Bring the output information up to date.
int InputIsOptional(int port)
virtual int UpdatePipelineMTime()
Bring the PipelineMTime up to date.
int InputCountIsValid(int port, vtkInformationVector **)
virtual void MarkOutputsGenerated(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
virtual int UpdateData(int outputPort)
Bring the output data up to date.
vtkTypeBool ProcessRequest(vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo) override
Generalized interface for asking the executive to fulfill update requests.
virtual int ExecuteInformation(vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
int InputTypeIsValid(vtkInformationVector **)
virtual int ExecuteData(vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
static vtkDemandDrivenPipeline * New()
int ArrayIsValid(vtkAbstractArray *array, vtkInformation *field)
int InputFieldsAreValid(vtkInformationVector **)
virtual int CheckDataObject(int port, vtkInformationVector *outInfo)
virtual void ExecuteDataStart(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
virtual void ExecuteDataEnd(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
virtual vtkTypeBool GetReleaseDataFlag(int port)
Get whether the given output port releases data when it is consumed.
vtkTypeBool Update() override
Bring the algorithm's outputs up-to-date.
int InputCountIsValid(vtkInformationVector **)
int FieldArrayExists(vtkFieldData *data, vtkInformation *field)
virtual int SetReleaseDataFlag(int port, vtkTypeBool n)
Set whether the given output port releases data when it is consumed.
vtkTypeBool Update(int port) override
Bring the algorithm's outputs up-to-date.
virtual int InputTypeIsValid(int port, int index, vtkInformationVector **)
int InputTypeIsValid(int port, vtkInformationVector **)
virtual int NeedToExecuteData(int outputPort, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
virtual int InputFieldsAreValid(int port, int index, vtkInformationVector **)
virtual int ExecuteDataObject(vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
int UpdateDataObject() override
Bring the output data object's existence up to date.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int InputFieldsAreValid(int port, vtkInformationVector **)
~vtkDemandDrivenPipeline() override
int DataSetAttributeExists(vtkDataSetAttributes *dsa, vtkInformation *field)
static vtkDataObject * NewDataObject(const char *type)
Create (New) and return a data object of the given type.
int InputIsRepeatable(int port)
Superclass for all pipeline executives in VTK.
Definition: vtkExecutive.h:48
represent and manipulate fields of data
Definition: vtkFieldData.h:61
a simple class to control print indentation
Definition: vtkIndent.h:38
Key for integer values in vtkInformation.
Key for vector-of-keys values.
Key for pointer to pointer.
Key for unsigned long values in vtkInformation.
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
record modification and/or execution time
Definition: vtkTimeStamp.h:34
static vtkInformationRequestKey * REQUEST_INFORMATION()
Key defining a request to make sure the output information is up to date.
static vtkInformationRequestKey * REQUEST_DATA_NOT_GENERATED()
Key defining a request to mark outputs that will NOT be generated during a REQUEST_DATA.
static vtkInformationIntegerKey * RELEASE_DATA()
Key to specify in pipeline information the request that data be released after it is used.
static vtkInformationIntegerKey * DATA_NOT_GENERATED()
Key to store a mark for an output that will not be generated.
static vtkInformationRequestKey * REQUEST_DATA()
Key defining a request to make sure the output data are up to date.
static vtkInformationRequestKey * REQUEST_DATA_OBJECT()
Key defining a request to make sure the output data objects exist.
@ field
Definition: vtkX3D.h:177
@ port
Definition: vtkX3D.h:447
@ type
Definition: vtkX3D.h:516
@ index
Definition: vtkX3D.h:246
@ data
Definition: vtkX3D.h:315
int vtkTypeBool
Definition: vtkABI.h:64
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:270