vtkStreamingDemandDrivenPipeline.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkStreamingDemandDrivenPipeline.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkStreamingDemandDrivenPipeline_h
#define vtkStreamingDemandDrivenPipeline_h

#include "vtkCommonExecutionModelModule.h" // For export macro
#include "vtkDemandDrivenPipeline.h"

#define VTK_UPDATE_EXTENT_COMBINE 1
#define VTK_UPDATE_EXTENT_REPLACE 2

class vtkInformationDoubleKey;
class vtkInformationDoubleVectorKey;
class vtkInformationIdTypeKey;
class vtkInformationIntegerKey;
class vtkInformationIntegerVectorKey;
class vtkInformationObjectBaseKey;
class vtkInformationStringKey;
class vtkInformationStringKey;
class vtkInformationUnsignedLongKey;

class VTKCOMMONEXECUTIONMODEL_EXPORT vtkStreamingDemandDrivenPipeline : public vtkDemandDrivenPipeline
{
public:
  static vtkStreamingDemandDrivenPipeline* New();
  vtkTypeMacro(vtkStreamingDemandDrivenPipeline,vtkDemandDrivenPipeline);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  int ProcessRequest(vtkInformation* request,
                             vtkInformationVector** inInfo,
                             vtkInformationVector* outInfo) VTK_OVERRIDE;


  int Update() VTK_OVERRIDE;
  int Update(int port) VTK_OVERRIDE;
  virtual int UpdateWholeExtent();

  virtual int Update(int port, vtkInformationVector* requests);

  int PropagateUpdateExtent(int outputPort);


  int PropagateTime(int outputPort);
  int UpdateTimeDependentInformation(int outputPort);


  static int SetWholeExtent(vtkInformation *, int extent[6]);
  static void GetWholeExtent(vtkInformation *, int extent[6]);
  static int* GetWholeExtent(vtkInformation *);


  int SetRequestExactExtent(int port, int flag);
  int GetRequestExactExtent(int port);

  static vtkInformationRequestKey* REQUEST_UPDATE_EXTENT();

  static vtkInformationRequestKey* REQUEST_UPDATE_TIME();
  static vtkInformationRequestKey* REQUEST_TIME_DEPENDENT_INFORMATION();

  static vtkInformationIntegerKey* CONTINUE_EXECUTING();

  static vtkInformationIntegerKey* UPDATE_EXTENT_INITIALIZED();
  static vtkInformationIntegerVectorKey* UPDATE_EXTENT();
  static vtkInformationIntegerKey* UPDATE_PIECE_NUMBER();
  static vtkInformationIntegerKey* UPDATE_NUMBER_OF_PIECES();
  static vtkInformationIntegerKey* UPDATE_NUMBER_OF_GHOST_LEVELS();

  static vtkInformationIntegerVectorKey* COMBINED_UPDATE_EXTENT();

  static vtkInformationIntegerVectorKey* WHOLE_EXTENT();

  static vtkInformationIntegerKey* UNRESTRICTED_UPDATE_EXTENT();

  static vtkInformationIntegerKey* EXACT_EXTENT();

  static vtkInformationDoubleVectorKey* TIME_STEPS();

  static vtkInformationDoubleVectorKey* TIME_RANGE();

  static vtkInformationDoubleKey* UPDATE_TIME_STEP();

  static vtkInformationIntegerKey* TIME_DEPENDENT_INFORMATION();

  static vtkInformationDoubleVectorKey *BOUNDS();


  VTK_LEGACY(int SetUpdateExtentToWholeExtent(int port));
  VTK_LEGACY(static int SetUpdateExtentToWholeExtent(vtkInformation *));


  VTK_LEGACY(int SetUpdateExtent(int port, int extent[6]));
  VTK_LEGACY(int SetUpdateExtent(int port, int x0, int x1, int y0, int y1, int z0, int z1));
  VTK_LEGACY(static int SetUpdateExtent(vtkInformation *, int extent[6]));
  static void GetUpdateExtent(vtkInformation *, int extent[6]);
  static int* GetUpdateExtent(vtkInformation *);


  VTK_LEGACY(int SetUpdateExtent(int port,
                      int piece, int numPieces, int ghostLevel));
  VTK_LEGACY(static int SetUpdateExtent(vtkInformation *,
                             int piece, int numPieces, int ghostLevel));
  VTK_LEGACY(static int SetUpdatePiece(vtkInformation *, int piece));
  static int GetUpdatePiece(vtkInformation *);
  VTK_LEGACY(static int SetUpdateNumberOfPieces(vtkInformation *, int n));
  static int GetUpdateNumberOfPieces(vtkInformation *);
  VTK_LEGACY(static int SetUpdateGhostLevel(vtkInformation *, int n));
  static int GetUpdateGhostLevel(vtkInformation *);


  VTK_LEGACY(int SetUpdateTimeStep(int port, double time));
  VTK_LEGACY(static int SetUpdateTimeStep(vtkInformation *, double time));

protected:
  vtkStreamingDemandDrivenPipeline();
  ~vtkStreamingDemandDrivenPipeline() VTK_OVERRIDE;

  static vtkInformationDoubleKey* PREVIOUS_UPDATE_TIME_STEP();

  // Does the time request correspond to what is in the data?
  // Returns 0 if yes, 1 otherwise.
  virtual int NeedToExecuteBasedOnTime(vtkInformation* outInfo,
                                       vtkDataObject* dataObject);

  // Setup default information on the output after the algorithm
  // executes information.
  int ExecuteInformation(vtkInformation* request,
                                 vtkInformationVector** inInfoVec,
                                 vtkInformationVector* outInfoVec) VTK_OVERRIDE;

  // Copy information for the given request.
  void CopyDefaultInformation(vtkInformation* request, int direction,
                                      vtkInformationVector** inInfoVec,
                                      vtkInformationVector* outInfoVec) VTK_OVERRIDE;

  // Helper to check output information before propagating it to inputs.
  virtual int VerifyOutputInformation(int outputPort,
                                      vtkInformationVector** inInfoVec,
                                      vtkInformationVector* outInfoVec);


  // Override this check to account for update extent.
  int NeedToExecuteData(int outputPort,
                                vtkInformationVector** inInfoVec,
                                vtkInformationVector* outInfoVec) VTK_OVERRIDE;

  // Override these to handle the continue-executing option.
  void ExecuteDataStart(vtkInformation* request,
                                vtkInformationVector** inInfoVec,
                                vtkInformationVector* outInfoVec) VTK_OVERRIDE;
  void ExecuteDataEnd(vtkInformation* request,
                              vtkInformationVector** inInfoVec,
                              vtkInformationVector* outInfoVec) VTK_OVERRIDE;

  // Override this to handle cropping and ghost levels.
  void MarkOutputsGenerated(vtkInformation* request,
                                    vtkInformationVector** inInfoVec,
                                    vtkInformationVector* outInfoVec) VTK_OVERRIDE;


  // Remove update/whole extent when resetting pipeline information.
  void ResetPipelineInformation(int port, vtkInformation*) VTK_OVERRIDE;

  // Flag for when an algorithm returns with CONTINUE_EXECUTING in the
  // request.
  int ContinueExecuting;

  vtkInformation *UpdateExtentRequest;

  // did the most recent PUE do anything ?
  int LastPropogateUpdateExtentShortCircuited;

private:
  vtkStreamingDemandDrivenPipeline(const vtkStreamingDemandDrivenPipeline&) VTK_DELETE_FUNCTION;
  void operator=(const vtkStreamingDemandDrivenPipeline&) VTK_DELETE_FUNCTION;
};

#endif