VTK  9.1.0
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=========================================================================*/
30#ifndef vtkDemandDrivenPipeline_h
31#define vtkDemandDrivenPipeline_h
32
33#include "vtkCommonExecutionModelModule.h" // For export macro
34#include "vtkExecutive.h"
35
37class vtkDataArray;
39class vtkDemandDrivenPipelineInternals;
40class vtkFieldData;
41class vtkInformation;
46
53
54class VTKCOMMONEXECUTIONMODEL_EXPORT vtkDemandDrivenPipeline : public vtkExecutive
55{
56public:
59 void PrintSelf(ostream& os, vtkIndent indent) override;
60
66 vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
67
72 vtkInformationVector* outInfoVec, int requestFromOutputPort, vtkMTimeType* mtime) override;
73
75
79 vtkTypeBool Update() override;
80 vtkTypeBool Update(int port) override;
82
84
87 vtkGetMacro(PipelineMTime, vtkMTimeType);
89
94 virtual int SetReleaseDataFlag(int port, int n);
95
99 virtual int GetReleaseDataFlag(int port);
100
104 virtual int UpdatePipelineMTime();
105
111 int UpdateDataObject() override;
112
116 int UpdateInformation() override;
117
123 virtual int UpdateData(int outputPort);
124
130
136
142
149
156
164
170 static vtkDataObject* NewDataObject(const char* type);
171
172protected:
175
176 // Helper methods to send requests to the algorithm.
177 virtual int ExecuteDataObject(
178 vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
180 vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
181 virtual int ExecuteData(
182 vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
183
184 // Reset the pipeline update values in the given output information object.
186
187 // Check whether the data object in the pipeline information for an
188 // output port exists and has a valid type.
189 virtual int CheckDataObject(int port, vtkInformationVector* outInfo);
190
191 // Input connection validity checkers.
196 virtual int InputTypeIsValid(int port, int index, vtkInformationVector**);
199 virtual int InputFieldsAreValid(int port, int index, vtkInformationVector**);
200
201 // Field existence checkers.
205
206 // Input port information checkers.
207 int InputIsOptional(int port);
208 int InputIsRepeatable(int port);
209
210 // Decide whether the output data need to be generated.
211 virtual int NeedToExecuteData(
212 int outputPort, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
213
214 // Handle before/after operations for ExecuteData method.
215 virtual void ExecuteDataStart(
216 vtkInformation* request, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
217 virtual void ExecuteDataEnd(
218 vtkInformation* request, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
220 vtkInformation* request, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
221
222 // Largest MTime of any algorithm on this executive or preceding
223 // executives.
225
226 // Time when information or data were last generated.
230
232
236
237private:
239 void operator=(const vtkDemandDrivenPipeline&) = delete;
240};
241
242#endif
Abstract superclass for all arrays.
Executive supporting composite datasets.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:159
general representation of visualization data
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)
static vtkDataObject * NewDataObject(const char *type)
Create (New) and return a data object of the given type.
int InputTypeIsValid(vtkInformationVector **)
virtual int ExecuteData(vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
int ArrayIsValid(vtkAbstractArray *array, vtkInformation *field)
int InputFieldsAreValid(vtkInformationVector **)
virtual int CheckDataObject(int port, vtkInformationVector *outInfo)
static vtkDemandDrivenPipeline * New()
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
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)
int InputIsRepeatable(int port)
Superclass for all pipeline executives in VTK.
Definition: vtkExecutive.h:76
represent and manipulate fields of data
Definition: vtkFieldData.h:164
a simple class to control print indentation
Definition: vtkIndent.h:113
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:52
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_OBJECT()
Key defining a request to make sure the output data objects exist.
static vtkInformationRequestKey * REQUEST_INFORMATION()
Key defining a request to make sure the output information is up to date.
static vtkInformationRequestKey * REQUEST_DATA()
Key defining a request to make sure the output data are up to date.
int vtkTypeBool
Definition: vtkABI.h:69
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287