VTK  9.2.6
vtkStreamingDemandDrivenPipeline.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkStreamingDemandDrivenPipeline.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 =========================================================================*/
141 #ifndef vtkStreamingDemandDrivenPipeline_h
142 #define vtkStreamingDemandDrivenPipeline_h
143 
144 #include "vtkCommonExecutionModelModule.h" // For export macro
145 #include "vtkDemandDrivenPipeline.h"
146 
147 #define VTK_UPDATE_EXTENT_COMBINE 1
148 #define VTK_UPDATE_EXTENT_REPLACE 2
149 
160 
161 class VTKCOMMONEXECUTIONMODEL_EXPORT vtkStreamingDemandDrivenPipeline
162  : public vtkDemandDrivenPipeline
163 {
164 public:
167  void PrintSelf(ostream& os, vtkIndent indent) override;
168 
174  vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
175 
177 
180  vtkTypeBool Update() override;
181  vtkTypeBool Update(int port) override;
184 
207  virtual vtkTypeBool Update(int port, vtkInformationVector* requests);
208 
214  int PropagateUpdateExtent(int outputPort);
215 
217 
221  int PropagateTime(int outputPort);
222  int UpdateTimeDependentInformation(int outputPort);
224 
226 
231  static int SetWholeExtent(vtkInformation*, int extent[6]);
232  static void GetWholeExtent(vtkInformation*, int extent[6]);
235 
237 
245  int SetRequestExactExtent(int port, int flag);
248 
254 
265 
272 
294 
301 
307 
315 
321 
327 
333 
339 
347 
353 
355 
358  static void GetUpdateExtent(vtkInformation*, int extent[6]);
362 
371 
372 protected:
375 
387 
388  // Does the time request correspond to what is in the data?
389  // Returns 0 if yes, 1 otherwise.
390  virtual int NeedToExecuteBasedOnTime(vtkInformation* outInfo, vtkDataObject* dataObject);
391 
392  // Setup default information on the output after the algorithm
393  // executes information.
395  vtkInformationVector* outInfoVec) override;
396 
397  // Copy information for the given request.
399  vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec) override;
400 
401  // Helper to check output information before propagating it to inputs.
403  int outputPort, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
404 
405  // Override this check to account for update extent.
407  int outputPort, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec) override;
408 
409  // Override these to handle the continue-executing option.
411  vtkInformationVector* outInfoVec) override;
413  vtkInformationVector* outInfoVec) override;
414 
415  // Override this to handle cropping and ghost levels.
417  vtkInformationVector* outInfoVec) override;
418 
419  // Remove update/whole extent when resetting pipeline information.
421 
422  // Flag for when an algorithm returns with CONTINUE_EXECUTING in the
423  // request.
425 
430 
431  // did the most recent PUE do anything ?
433 
434 private:
436  void operator=(const vtkStreamingDemandDrivenPipeline&) = delete;
437 };
438 
439 #endif
general representation of visualization data
Executive supporting on-demand execution.
a simple class to control print indentation
Definition: vtkIndent.h:119
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:266
@ port
Definition: vtkX3D.h:453
@ extent
Definition: vtkX3D.h:351
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_SIZEHINT(...)