VTK  9.3.0
vtkStreamingDemandDrivenPipeline.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
20 #ifndef vtkStreamingDemandDrivenPipeline_h
21 #define vtkStreamingDemandDrivenPipeline_h
22 
23 #include "vtkCommonExecutionModelModule.h" // For export macro
25 
26 #define VTK_UPDATE_EXTENT_COMBINE 1
27 #define VTK_UPDATE_EXTENT_REPLACE 2
28 
29 VTK_ABI_NAMESPACE_BEGIN
40 
41 class VTKCOMMONEXECUTIONMODEL_EXPORT vtkStreamingDemandDrivenPipeline
43 {
44 public:
47  void PrintSelf(ostream& os, vtkIndent indent) override;
48 
54  vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
55 
57 
60  vtkTypeBool Update() override;
61  vtkTypeBool Update(int port) override;
64 
87  virtual vtkTypeBool Update(int port, vtkInformationVector* requests);
88 
94  int PropagateUpdateExtent(int outputPort);
95 
97 
101  int PropagateTime(int outputPort);
102  int UpdateTimeDependentInformation(int outputPort);
104 
106 
111  static int SetWholeExtent(vtkInformation*, int extent[6]);
112  static void GetWholeExtent(vtkInformation*, int extent[6]);
115 
117 
125  int SetRequestExactExtent(int port, int flag);
128 
134 
145 
152 
174 
181 
187 
195 
201 
207 
213 
219 
227 
233 
235 
238  static void GetUpdateExtent(vtkInformation*, int extent[6]);
242 
251 
252 protected:
255 
267 
268  // Does the time request correspond to what is in the data?
269  // Returns 0 if yes, 1 otherwise.
270  virtual int NeedToExecuteBasedOnTime(vtkInformation* outInfo, vtkDataObject* dataObject);
271 
272  // Setup default information on the output after the algorithm
273  // executes information.
275  vtkInformationVector* outInfoVec) override;
276 
277  // Copy information for the given request.
279  vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec) override;
280 
281  // Helper to check output information before propagating it to inputs.
283  int outputPort, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
284 
285  // Override this check to account for update extent.
287  int outputPort, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec) override;
288 
289  // Override these to handle the continue-executing option.
291  vtkInformationVector* outInfoVec) override;
293  vtkInformationVector* outInfoVec) override;
294 
295  // Override this to handle cropping and ghost levels.
297  vtkInformationVector* outInfoVec) override;
298 
299  // Remove update/whole extent when resetting pipeline information.
301 
302  // Flag for when an algorithm returns with CONTINUE_EXECUTING in the
303  // request.
305 
310 
311  // did the most recent PUE do anything ?
313 
314 private:
316  void operator=(const vtkStreamingDemandDrivenPipeline&) = delete;
317 };
318 
319 VTK_ABI_NAMESPACE_END
320 #endif
general representation of visualization data
Definition: vtkDataObject.h:55
Executive supporting on-demand execution.
a simple class to control print indentation
Definition: vtkIndent.h:29
Key for double values in vtkInformation.
Key for vtkIdType values in vtkInformation.
Key for integer values in vtkInformation.
Iterates over keys of an information object.
Key for vtkObjectBase values.
Key for pointer to pointer.
Key for string values in vtkInformation.
Key for unsigned long values in vtkInformation.
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Executive supporting partial updates.
static vtkStreamingDemandDrivenPipeline * New()
void MarkOutputsGenerated(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
static int * GetWholeExtent(vtkInformation *)
Set/Get the whole extent of an output port.
vtkTypeBool ProcessRequest(vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo) override
Generalized interface for asking the executive to fulfill update requests.
static int GetUpdateGhostLevel(vtkInformation *)
Set/Get the update piece, update number of pieces, and update number of ghost levels for an output po...
virtual int NeedToExecuteBasedOnTime(vtkInformation *outInfo, vtkDataObject *dataObject)
int ExecuteInformation(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
virtual vtkTypeBool Update(int port, vtkInformationVector *requests)
This method enables the passing of data requests to the algorithm to be used during execution (in add...
int PropagateTime(int outputPort)
Propagate time through the pipeline.
virtual vtkTypeBool UpdateWholeExtent()
Bring the outputs up-to-date.
vtkTypeBool Update(int port) override
Bring the outputs up-to-date.
virtual int VerifyOutputInformation(int outputPort, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static void GetUpdateExtent(vtkInformation *, int extent[6])
Get/Set the update extent for output ports that use 3D extents.
static int GetUpdatePiece(vtkInformation *)
Set/Get the update piece, update number of pieces, and update number of ghost levels for an output po...
void ResetPipelineInformation(int port, vtkInformation *) override
int GetRequestExactExtent(int port)
This request flag indicates whether the requester can handle more data than requested for the given p...
static int * GetUpdateExtent(vtkInformation *)
Get/Set the update extent for output ports that use 3D extents.
int UpdateTimeDependentInformation(int outputPort)
Propagate time through the pipeline.
int PropagateUpdateExtent(int outputPort)
Propagate the update request from the given output port back through the pipeline.
void ExecuteDataEnd(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
int NeedToExecuteData(int outputPort, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
void CopyDefaultInformation(vtkInformation *request, int direction, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
static void GetWholeExtent(vtkInformation *, int extent[6])
Set/Get the whole extent of an output port.
static int SetWholeExtent(vtkInformation *, int extent[6])
Set/Get the whole extent of an output port.
static int GetUpdateNumberOfPieces(vtkInformation *)
Set/Get the update piece, update number of pieces, and update number of ghost levels for an output po...
int SetRequestExactExtent(int port, int flag)
This request flag indicates whether the requester can handle more data than requested for the given p...
void ExecuteDataStart(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
vtkTypeBool Update() override
Bring the outputs up-to-date.
static vtkInformationRequestKey * REQUEST_TIME_DEPENDENT_INFORMATION()
Key defining a request to make sure the meta information is up to date.
static vtkInformationIntegerVectorKey * WHOLE_EXTENT()
Key to store the whole extent provided in pipeline information.
static vtkInformationIntegerVectorKey * COMBINED_UPDATE_EXTENT()
Key for combining the update extents requested by all consumers, so that the final extent that is pro...
static vtkInformationDoubleVectorKey * TIME_RANGE()
Key to store available time range for continuous sources.
static vtkInformationIntegerKey * EXACT_EXTENT()
Key to specify the request for exact extent in pipeline information.
static vtkInformationIntegerKey * UPDATE_NUMBER_OF_GHOST_LEVELS()
static vtkInformationIntegerKey * UPDATE_PIECE_NUMBER()
static vtkInformationIntegerKey * UNRESTRICTED_UPDATE_EXTENT()
This is set if the update extent is not restricted to the whole extent, for sources that can generate...
static vtkInformationRequestKey * REQUEST_UPDATE_TIME()
Key defining a request to propagate the update extent upstream.
static vtkInformationRequestKey * REQUEST_UPDATE_EXTENT()
Key defining a request to propagate the update extent upstream.
static vtkInformationDoubleKey * UPDATE_TIME_STEP()
Update time steps requested by the pipeline.
static vtkInformationDoubleVectorKey * BOUNDS()
key to record the bounds of a dataset.
static vtkInformationDoubleVectorKey * TIME_STEPS()
Key to store available time steps.
static vtkInformationIntegerKey * UPDATE_EXTENT_INITIALIZED()
Keys to store an update request in pipeline information.
static vtkInformationIntegerVectorKey * UPDATE_EXTENT()
static vtkInformationDoubleKey * PREVIOUS_UPDATE_TIME_STEP()
Keep track of the update time request corresponding to the previous executing.
static vtkInformationIntegerKey * TIME_DEPENDENT_INFORMATION()
Whether there are time dependent meta information if there is, the pipeline will perform two extra pa...
static vtkInformationIntegerKey * UPDATE_NUMBER_OF_PIECES()
static vtkInformationIntegerKey * CONTINUE_EXECUTING()
Key for an algorithm to store in a request to tell this executive to keep executing it.
@ direction
Definition: vtkX3D.h:260
@ port
Definition: vtkX3D.h:447
@ extent
Definition: vtkX3D.h:345
int vtkTypeBool
Definition: vtkABI.h:64
#define VTK_SIZEHINT(...)