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
18 #ifndef vtkDemandDrivenPipeline_h
19 #define vtkDemandDrivenPipeline_h
20 
21 #include "vtkCommonExecutionModelModule.h" // For export macro
22 #include "vtkExecutive.h"
23 
24 VTK_ABI_NAMESPACE_BEGIN
25 class vtkAbstractArray;
26 class vtkDataArray;
28 class vtkDemandDrivenPipelineInternals;
29 class vtkFieldData;
30 class vtkInformation;
35 
42 
43 class VTKCOMMONEXECUTIONMODEL_EXPORT vtkDemandDrivenPipeline : public vtkExecutive
44 {
45 public:
48  void PrintSelf(ostream& os, vtkIndent indent) override;
49 
55  vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
56 
61  vtkInformationVector* outInfoVec, int requestFromOutputPort, vtkMTimeType* mtime) override;
62 
64 
68  vtkTypeBool Update() override;
69  vtkTypeBool Update(int port) override;
71 
73 
76  vtkGetMacro(PipelineMTime, vtkMTimeType);
78 
83  virtual int SetReleaseDataFlag(int port, vtkTypeBool n);
84 
89 
93  virtual int UpdatePipelineMTime();
94 
100  int UpdateDataObject() override;
101 
105  int UpdateInformation() override;
106 
112  virtual int UpdateData(int outputPort);
113 
119 
125 
131 
138 
145 
153 
159  static vtkDataObject* NewDataObject(const char* type);
160 
161 protected:
164 
165  // Helper methods to send requests to the algorithm.
166  virtual int ExecuteDataObject(
167  vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
168  virtual int ExecuteInformation(
169  vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
170  virtual int ExecuteData(
171  vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
172 
173  // Reset the pipeline update values in the given output information object.
175 
176  // Check whether the data object in the pipeline information for an
177  // output port exists and has a valid type.
178  virtual int CheckDataObject(int port, vtkInformationVector* outInfo);
179 
180  // Input connection validity checkers.
189 
190  // Field existence checkers.
194 
195  // Input port information checkers.
198 
199  // Decide whether the output data need to be generated.
200  virtual int NeedToExecuteData(
201  int outputPort, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
202 
203  // Handle before/after operations for ExecuteData method.
204  virtual void ExecuteDataStart(
205  vtkInformation* request, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
206  virtual void ExecuteDataEnd(
207  vtkInformation* request, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
208  virtual void MarkOutputsGenerated(
209  vtkInformation* request, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
210 
211  // Largest MTime of any algorithm on this executive or preceding
212  // executives.
214 
215  // Time when information or data were last generated.
219 
221 
225 
226 private:
228  void operator=(const vtkDemandDrivenPipeline&) = delete;
229 };
230 
231 VTK_ABI_NAMESPACE_END
232 #endif
Abstract superclass for all arrays.
Executive supporting composite datasets.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:45
general representation of visualization data
Definition: vtkDataObject.h:55
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:39
represent and manipulate fields of data
Definition: vtkFieldData.h:52
a simple class to control print indentation
Definition: vtkIndent.h:29
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:25
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