VTK  9.2.6
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=========================================================================*/
27#ifndef vtkDemandDrivenPipeline_h
28#define vtkDemandDrivenPipeline_h
29
30#include "vtkCommonExecutionModelModule.h" // For export macro
31#include "vtkExecutive.h"
32
34class vtkDataArray;
36class vtkDemandDrivenPipelineInternals;
37class vtkFieldData;
38class vtkInformation;
43
50
51class VTKCOMMONEXECUTIONMODEL_EXPORT vtkDemandDrivenPipeline : public vtkExecutive
52{
53public:
56 void PrintSelf(ostream& os, vtkIndent indent) override;
57
63 vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
64
69 vtkInformationVector* outInfoVec, int requestFromOutputPort, vtkMTimeType* mtime) override;
70
72
76 vtkTypeBool Update() override;
77 vtkTypeBool Update(int port) override;
79
81
84 vtkGetMacro(PipelineMTime, vtkMTimeType);
86
91 virtual int SetReleaseDataFlag(int port, int n);
92
96 virtual int GetReleaseDataFlag(int port);
97
101 virtual int UpdatePipelineMTime();
102
108 int UpdateDataObject() override;
109
113 int UpdateInformation() override;
114
120 virtual int UpdateData(int outputPort);
121
127
133
139
146
153
161
167 static vtkDataObject* NewDataObject(const char* type);
168
169protected:
172
173 // Helper methods to send requests to the algorithm.
174 virtual int ExecuteDataObject(
175 vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
177 vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
178 virtual int ExecuteData(
179 vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
180
181 // Reset the pipeline update values in the given output information object.
183
184 // Check whether the data object in the pipeline information for an
185 // output port exists and has a valid type.
186 virtual int CheckDataObject(int port, vtkInformationVector* outInfo);
187
188 // Input connection validity checkers.
193 virtual int InputTypeIsValid(int port, int index, vtkInformationVector**);
196 virtual int InputFieldsAreValid(int port, int index, vtkInformationVector**);
197
198 // Field existence checkers.
202
203 // Input port information checkers.
204 int InputIsOptional(int port);
205 int InputIsRepeatable(int port);
206
207 // Decide whether the output data need to be generated.
208 virtual int NeedToExecuteData(
209 int outputPort, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
210
211 // Handle before/after operations for ExecuteData method.
212 virtual void ExecuteDataStart(
213 vtkInformation* request, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
214 virtual void ExecuteDataEnd(
215 vtkInformation* request, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
217 vtkInformation* request, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
218
219 // Largest MTime of any algorithm on this executive or preceding
220 // executives.
222
223 // Time when information or data were last generated.
227
229
233
234private:
236 void operator=(const vtkDemandDrivenPipeline&) = delete;
237};
238
239#endif
Abstract superclass for all arrays.
Executive supporting composite datasets.
abstract superclass for arrays of numeric data
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.
represent and manipulate fields of data
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
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