VTK  9.0.3
vtkDemandDrivenPipeline.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkDemandDrivenPipeline.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
24 #ifndef vtkDemandDrivenPipeline_h
25 #define vtkDemandDrivenPipeline_h
26 
27 #include "vtkCommonExecutionModelModule.h" // For export macro
28 #include "vtkExecutive.h"
29 
30 class vtkAbstractArray;
31 class vtkDataArray;
33 class vtkDemandDrivenPipelineInternals;
34 class vtkFieldData;
35 class vtkInformation;
40 
47 
48 class VTKCOMMONEXECUTIONMODEL_EXPORT vtkDemandDrivenPipeline : public vtkExecutive
49 {
50 public:
53  void PrintSelf(ostream& os, vtkIndent indent) override;
54 
60  vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
61 
66  vtkInformationVector* outInfoVec, int requestFromOutputPort, vtkMTimeType* mtime) override;
67 
69 
73  vtkTypeBool Update() override;
74  vtkTypeBool Update(int port) override;
76 
78 
81  vtkGetMacro(PipelineMTime, vtkMTimeType);
83 
88  virtual int SetReleaseDataFlag(int port, int n);
89 
93  virtual int GetReleaseDataFlag(int port);
94 
98  virtual int UpdatePipelineMTime();
99 
105  int UpdateDataObject() override;
106 
110  int UpdateInformation() override;
111 
117  virtual int UpdateData(int outputPort);
118 
124 
130 
136 
143 
150 
158 
164  static vtkDataObject* NewDataObject(const char* type);
165 
166 protected:
169 
170  // Helper methods to send requests to the algorithm.
171  virtual int ExecuteDataObject(
172  vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
173  virtual int ExecuteInformation(
174  vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
175  virtual int ExecuteData(
176  vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
177 
178  // Reset the pipeline update values in the given output information object.
180 
181  // Check whether the data object in the pipeline information for an
182  // output port exists and has a valid type.
183  virtual int CheckDataObject(int port, vtkInformationVector* outInfo);
184 
185  // Input connection validity checkers.
194 
195  // Field existence checkers.
199 
200  // Input port information checkers.
203 
204  // Decide whether the output data need to be generated.
205  virtual int NeedToExecuteData(
206  int outputPort, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
207 
208  // Handle before/after operations for ExecuteData method.
209  virtual void ExecuteDataStart(
210  vtkInformation* request, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
211  virtual void ExecuteDataEnd(
212  vtkInformation* request, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
213  virtual void MarkOutputsGenerated(
214  vtkInformation* request, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
215 
216  // Largest MTime of any algorithm on this executive or preceding
217  // executives.
219 
220  // Time when information or data were last generated.
224 
226 
230 
231 private:
233  void operator=(const vtkDemandDrivenPipeline&) = delete;
234 };
235 
236 #endif
Abstract superclass for all arrays.
Executive supporting composite datasets.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:50
general representation of visualization data
Definition: vtkDataObject.h:60
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 int GetReleaseDataFlag(int port)
Get whether the given output port releases data when it is consumed.
virtual void ExecuteDataStart(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
virtual int SetReleaseDataFlag(int port, int n)
Set whether the given output port releases data when it is consumed.
virtual void ExecuteDataEnd(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
vtkTypeBool Update() override
Bring the algorithm's outputs up-to-date.
int InputCountIsValid(vtkInformationVector **)
int FieldArrayExists(vtkFieldData *data, vtkInformation *field)
vtkTypeBool Update(int port) override
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:47
represent and manipulate fields of data
Definition: vtkFieldData.h:54
a simple class to control print indentation
Definition: vtkIndent.h:34
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:33
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:183
@ port
Definition: vtkX3D.h:453
@ type
Definition: vtkX3D.h:522
@ index
Definition: vtkX3D.h:252
@ data
Definition: vtkX3D.h:321
int vtkTypeBool
Definition: vtkABI.h:69
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:293