VTK  9.1.0
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=========================================================================*/
135#ifndef vtkStreamingDemandDrivenPipeline_h
136#define vtkStreamingDemandDrivenPipeline_h
137
138#include "vtkCommonExecutionModelModule.h" // For export macro
140
141#define VTK_UPDATE_EXTENT_COMBINE 1
142#define VTK_UPDATE_EXTENT_REPLACE 2
143
154
155class VTKCOMMONEXECUTIONMODEL_EXPORT vtkStreamingDemandDrivenPipeline
157{
158public:
161 void PrintSelf(ostream& os, vtkIndent indent) override;
162
168 vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;
169
171
174 vtkTypeBool Update() override;
175 vtkTypeBool Update(int port) override;
178
201 virtual vtkTypeBool Update(int port, vtkInformationVector* requests);
202
208 int PropagateUpdateExtent(int outputPort);
209
211
215 int PropagateTime(int outputPort);
218
220
225 static int SetWholeExtent(vtkInformation*, int extent[6]);
226 static void GetWholeExtent(vtkInformation*, int extent[6]);
229
231
239 int SetRequestExactExtent(int port, int flag);
242
248
259
266
288
295
301
309
315
321
327
333
341
347
349
352 static void GetUpdateExtent(vtkInformation*, int extent[6]);
356
365
366protected:
369
381
382 // Does the time request correspond to what is in the data?
383 // Returns 0 if yes, 1 otherwise.
384 virtual int NeedToExecuteBasedOnTime(vtkInformation* outInfo, vtkDataObject* dataObject);
385
386 // Setup default information on the output after the algorithm
387 // executes information.
389 vtkInformationVector* outInfoVec) override;
390
391 // Copy information for the given request.
392 void CopyDefaultInformation(vtkInformation* request, int direction,
393 vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec) override;
394
395 // Helper to check output information before propagating it to inputs.
397 int outputPort, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
398
399 // Override this check to account for update extent.
401 int outputPort, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec) override;
402
403 // Override these to handle the continue-executing option.
405 vtkInformationVector* outInfoVec) override;
407 vtkInformationVector* outInfoVec) override;
408
409 // Override this to handle cropping and ghost levels.
411 vtkInformationVector* outInfoVec) override;
412
413 // Remove update/whole extent when resetting pipeline information.
414 void ResetPipelineInformation(int port, vtkInformation*) override;
415
416 // Flag for when an algorithm returns with CONTINUE_EXECUTING in the
417 // request.
419
424
425 // did the most recent PUE do anything ?
427
428private:
430 void operator=(const vtkStreamingDemandDrivenPipeline&) = delete;
431};
432
433#endif
general representation of visualization data
Executive supporting on-demand execution.
a simple class to control print indentation
Definition: vtkIndent.h:113
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.
void MarkOutputsGenerated(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
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
static vtkStreamingDemandDrivenPipeline * New()
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...
static int * GetWholeExtent(vtkInformation *)
Set/Get the whole extent of an output port.
void ExecuteDataStart(vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
vtkTypeBool Update() override
Bring the outputs up-to-date.
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 vtkInformationIntegerKey * UPDATE_PIECE_NUMBER()
static vtkInformationDoubleKey * UPDATE_TIME_STEP()
Update time steps requested by the pipeline.
static vtkInformationIntegerKey * TIME_DEPENDENT_INFORMATION()
Whether there are time dependent meta information if there is, the pipeline will perform two extra pa...
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 * UPDATE_EXTENT()
static vtkInformationIntegerKey * UPDATE_NUMBER_OF_PIECES()
static vtkInformationDoubleVectorKey * BOUNDS()
key to record the bounds of a dataset.
static vtkInformationDoubleVectorKey * TIME_RANGE()
Key to store available time range for continuous sources.
static vtkInformationIntegerKey * UPDATE_NUMBER_OF_GHOST_LEVELS()
static vtkInformationIntegerKey * UPDATE_EXTENT_INITIALIZED()
Keys to store an update request 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 vtkInformationIntegerKey * CONTINUE_EXECUTING()
Key for an algorithm to store in a request to tell this executive to keep executing it.
static vtkInformationDoubleVectorKey * TIME_STEPS()
Key to store available time steps.
static vtkInformationRequestKey * REQUEST_UPDATE_EXTENT()
Key defining a request to propagate the update extent upstream.
static vtkInformationDoubleKey * PREVIOUS_UPDATE_TIME_STEP()
Keep track of the update time request corresponding to the previous executing.
static vtkInformationRequestKey * REQUEST_UPDATE_TIME()
Key defining a request to propagate the update extent upstream.
static vtkInformationIntegerKey * EXACT_EXTENT()
Key to specify the request for exact extent in pipeline information.
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_SIZEHINT(...)