VTK
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 
33 class vtkAbstractArray;
34 class vtkDataArray;
36 class vtkDemandDrivenPipelineInternals;
37 class vtkFieldData;
38 class vtkInformation;
43 
50 
51 class VTKCOMMONEXECUTIONMODEL_EXPORT vtkDemandDrivenPipeline : public vtkExecutive
52 {
53 public:
56  void PrintSelf(ostream& os, vtkIndent indent) override;
57 
63  vtkInformationVector** inInfo,
64  vtkInformationVector* outInfo) override;
65 
69  int
71  vtkInformationVector** inInfoVec,
72  vtkInformationVector* outInfoVec,
73  int requestFromOutputPort,
74  vtkMTimeType* mtime) override;
75 
77 
81  int Update() override;
82  int Update(int port) override;
84 
86 
89  vtkGetMacro(PipelineMTime, vtkMTimeType);
91 
96  virtual int SetReleaseDataFlag(int port, int n);
97 
101  virtual int GetReleaseDataFlag(int port);
102 
106  virtual int UpdatePipelineMTime();
107 
113  int UpdateDataObject() override;
114 
118  int UpdateInformation() override;
119 
125  virtual int UpdateData(int outputPort);
126 
132 
138 
144 
151 
158 
166 
172  static vtkDataObject* NewDataObject(const char* type);
173 
174 protected:
177 
178  // Helper methods to send requests to the algorithm.
179  virtual int ExecuteDataObject(vtkInformation* request,
180  vtkInformationVector** inInfo,
181  vtkInformationVector* outInfo);
182  virtual int ExecuteInformation(vtkInformation* request,
183  vtkInformationVector** inInfo,
184  vtkInformationVector* outInfo);
185  virtual int ExecuteData(vtkInformation* request,
186  vtkInformationVector** inInfo,
187  vtkInformationVector* outInfo);
188 
189 
190  // Reset the pipeline update values in the given output information object.
192 
193  // Check whether the data object in the pipeline information for an
194  // output port exists and has a valid type.
195  virtual int CheckDataObject(int port, vtkInformationVector* outInfo);
196 
197 
198  // Input connection validity checkers.
207 
208  // Field existence checkers.
212 
213  // Input port information checkers.
216 
217  // Decide whether the output data need to be generated.
218  virtual int NeedToExecuteData(int outputPort,
219  vtkInformationVector** inInfoVec,
220  vtkInformationVector* outInfoVec);
221 
222  // Handle before/after operations for ExecuteData method.
223  virtual void ExecuteDataStart(vtkInformation* request,
224  vtkInformationVector** inInfoVec,
225  vtkInformationVector* outInfoVec);
226  virtual void ExecuteDataEnd(vtkInformation* request,
227  vtkInformationVector** inInfoVec,
228  vtkInformationVector* outInfoVec);
229  virtual void MarkOutputsGenerated(vtkInformation* request,
230  vtkInformationVector** inInfoVec,
231  vtkInformationVector* outInfoVec);
232 
233  // Largest MTime of any algorithm on this executive or preceding
234  // executives.
236 
237  // Time when information or data were last generated.
241 
243 
247 
248 private:
250  void operator=(const vtkDemandDrivenPipeline&) = delete;
251 };
252 
253 #endif
vtkDemandDrivenPipeline::InputIsRepeatable
int InputIsRepeatable(int port)
vtkDemandDrivenPipeline
Executive supporting on-demand execution.
Definition: vtkDemandDrivenPipeline.h:52
vtkInformationKeyVectorKey
Key for vector-of-keys values.
Definition: vtkInformationKeyVectorKey.h:32
vtkDemandDrivenPipeline::DataRequest
vtkInformation * DataRequest
Definition: vtkDemandDrivenPipeline.h:246
vtkDemandDrivenPipeline::vtkDemandDrivenPipeline
vtkDemandDrivenPipeline()
vtkDemandDrivenPipeline::ArrayIsValid
int ArrayIsValid(vtkAbstractArray *array, vtkInformation *field)
vtkDemandDrivenPipeline::REQUEST_INFORMATION
static vtkInformationRequestKey * REQUEST_INFORMATION()
Key defining a request to make sure the output information is up to date.
vtkDemandDrivenPipeline::DataObjectTime
vtkTimeStamp DataObjectTime
Definition: vtkDemandDrivenPipeline.h:238
vtkDemandDrivenPipeline::InputTypeIsValid
virtual int InputTypeIsValid(int port, int index, vtkInformationVector **)
vtkX3D::type
@ type
Definition: vtkX3D.h:516
vtkDemandDrivenPipeline::InputTypeIsValid
int InputTypeIsValid(int port, vtkInformationVector **)
vtkDataSetAttributes
represent and manipulate attribute data in a dataset
Definition: vtkDataSetAttributes.h:60
vtkX3D::data
@ data
Definition: vtkX3D.h:315
vtkDemandDrivenPipeline::ComputePipelineMTime
int ComputePipelineMTime(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime) override
Implement the pipeline modified time request.
vtkDemandDrivenPipeline::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:42
vtkDemandDrivenPipeline::REQUEST_DATA_NOT_GENERATED
static vtkInformationRequestKey * REQUEST_DATA_NOT_GENERATED()
Key defining a request to mark outputs that will NOT be generated during a REQUEST_DATA.
vtkTimeStamp
record modification and/or execution time
Definition: vtkTimeStamp.h:36
vtkDemandDrivenPipeline::PipelineMTime
vtkMTimeType PipelineMTime
Definition: vtkDemandDrivenPipeline.h:235
vtkDemandDrivenPipeline::ExecuteData
virtual int ExecuteData(vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
vtkDemandDrivenPipeline::MarkOutputsGenerated
virtual void MarkOutputsGenerated(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
vtkDemandDrivenPipeline::DATA_NOT_GENERATED
static vtkInformationIntegerKey * DATA_NOT_GENERATED()
Key to store a mark for an output that will not be generated.
vtkExecutive.h
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
vtkDemandDrivenPipeline::REQUEST_DATA_OBJECT
static vtkInformationRequestKey * REQUEST_DATA_OBJECT()
Key defining a request to make sure the output data objects exist.
vtkDemandDrivenPipeline::ExecuteInformation
virtual int ExecuteInformation(vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
vtkDemandDrivenPipeline::ExecuteDataStart
virtual void ExecuteDataStart(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
vtkDemandDrivenPipeline::UpdateInformation
int UpdateInformation() override
Bring the output information up to date.
vtkFieldData
represent and manipulate fields of data
Definition: vtkFieldData.h:57
vtkDemandDrivenPipeline::UpdateDataObject
int UpdateDataObject() override
Bring the output data object's existence up to date.
vtkX3D::port
@ port
Definition: vtkX3D.h:447
vtkDemandDrivenPipeline::InfoRequest
vtkInformation * InfoRequest
Definition: vtkDemandDrivenPipeline.h:244
vtkExecutive
Superclass for all pipeline executives in VTK.
Definition: vtkExecutive.h:50
vtkDemandDrivenPipeline::NewDataObject
static vtkDataObject * NewDataObject(const char *type)
Create (New) and return a data object of the given type.
vtkDemandDrivenPipeline::ResetPipelineInformation
void ResetPipelineInformation(int, vtkInformation *) override
vtkCompositeDataPipeline
Executive supporting composite datasets.
Definition: vtkCompositeDataPipeline.h:70
vtkDemandDrivenPipeline::REQUEST_DATA
static vtkInformationRequestKey * REQUEST_DATA()
Key defining a request to make sure the output data are up to date.
vtkDemandDrivenPipeline::UpdatePipelineMTime
virtual int UpdatePipelineMTime()
Bring the PipelineMTime up to date.
vtkDemandDrivenPipeline::InputCountIsValid
int InputCountIsValid(int port, vtkInformationVector **)
vtkInformationIntegerKey
Key for integer values in vtkInformation.
Definition: vtkInformationIntegerKey.h:35
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkX3D::field
@ field
Definition: vtkX3D.h:177
vtkDemandDrivenPipeline::FieldArrayExists
int FieldArrayExists(vtkFieldData *data, vtkInformation *field)
vtkDemandDrivenPipeline::InformationTime
vtkTimeStamp InformationTime
Definition: vtkDemandDrivenPipeline.h:239
vtkInformationRequestKey
Key for pointer to pointer.
Definition: vtkInformationRequestKey.h:32
vtkDemandDrivenPipeline::New
static vtkDemandDrivenPipeline * New()
vtkDemandDrivenPipeline::ExecuteDataObject
virtual int ExecuteDataObject(vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
vtkInformationUnsignedLongKey
Key for unsigned long values in vtkInformation.
Definition: vtkInformationUnsignedLongKey.h:35
vtkDemandDrivenPipeline::DataObjectRequest
vtkInformation * DataObjectRequest
Definition: vtkDemandDrivenPipeline.h:245
vtkDemandDrivenPipeline::NeedToExecuteData
virtual int NeedToExecuteData(int outputPort, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
vtkDemandDrivenPipeline::InputIsOptional
int InputIsOptional(int port)
vtkDemandDrivenPipeline::InputTypeIsValid
int InputTypeIsValid(vtkInformationVector **)
vtkAbstractArray
Abstract superclass for all arrays.
Definition: vtkAbstractArray.h:79
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkDemandDrivenPipeline::InputFieldsAreValid
int InputFieldsAreValid(int port, vtkInformationVector **)
vtkDemandDrivenPipeline::Update
int Update() override
Bring the algorithm's outputs up-to-date.
vtkDemandDrivenPipeline::ExecuteDataEnd
virtual void ExecuteDataEnd(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
vtkDemandDrivenPipeline::ProcessRequest
int ProcessRequest(vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo) override
Generalized interface for asking the executive to fulfill update requests.
vtkDemandDrivenPipeline::InputFieldsAreValid
int InputFieldsAreValid(vtkInformationVector **)
vtkDemandDrivenPipeline::InputCountIsValid
int InputCountIsValid(vtkInformationVector **)
vtkDemandDrivenPipeline::SetReleaseDataFlag
virtual int SetReleaseDataFlag(int port, int n)
Set whether the given output port releases data when it is consumed.
vtkDemandDrivenPipeline::Update
int Update(int port) override
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:65
vtkDemandDrivenPipeline::UpdateData
virtual int UpdateData(int outputPort)
Bring the output data up to date.
vtkDemandDrivenPipeline::DataTime
vtkTimeStamp DataTime
Definition: vtkDemandDrivenPipeline.h:240
vtkX3D::index
@ index
Definition: vtkX3D.h:246
vtkDemandDrivenPipeline::InputFieldsAreValid
virtual int InputFieldsAreValid(int port, int index, vtkInformationVector **)
vtkDemandDrivenPipeline::DataSetAttributeExists
int DataSetAttributeExists(vtkDataSetAttributes *dsa, vtkInformation *field)
vtkDemandDrivenPipeline::~vtkDemandDrivenPipeline
~vtkDemandDrivenPipeline() override
vtkDemandDrivenPipeline::GetReleaseDataFlag
virtual int GetReleaseDataFlag(int port)
Get whether the given output port releases data when it is consumed.
vtkDemandDrivenPipeline::RELEASE_DATA
static vtkInformationIntegerKey * RELEASE_DATA()
Key to specify in pipeline information the request that data be released after it is used.
vtkDemandDrivenPipeline::CheckDataObject
virtual int CheckDataObject(int port, vtkInformationVector *outInfo)
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:302