dox/Common/ExecutionModel/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 vtkExtentTranslator;
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);


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


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

  int PropagateUpdateExtent(int outputPort);



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



  int SetMaximumNumberOfPieces(int port, int n);
  static int SetMaximumNumberOfPieces(vtkInformation *, int n);
  int GetMaximumNumberOfPieces(int port);
  static int GetMaximumNumberOfPieces(vtkInformation *);


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


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


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


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


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


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


  int SetExtentTranslator(int port, vtkExtentTranslator* translator);
  static int SetExtentTranslator(vtkInformation *, vtkExtentTranslator* translator);
  vtkExtentTranslator* GetExtentTranslator(int port);
  static vtkExtentTranslator* GetExtentTranslator(vtkInformation *info);


  int SetWholeBoundingBox(int port, double bb[6]);
  void GetWholeBoundingBox(int port, double bb[6]);
  double* GetWholeBoundingBox(int port);


  int SetPieceBoundingBox(int port, double bb[6]);
  void GetPieceBoundingBox(int port, double bb[6]);
  double* GetPieceBoundingBox(int port);

  static vtkInformationRequestKey* REQUEST_UPDATE_EXTENT();

  // Key defining a request to propagate the update extent upstream.
  static vtkInformationRequestKey* REQUEST_UPDATE_TIME();
  static vtkInformationRequestKey* REQUEST_TIME_DEPENDENT_INFORMATION();



  static vtkInformationRequestKey* REQUEST_UPDATE_EXTENT_INFORMATION();
  static vtkInformationRequestKey* REQUEST_MANAGE_INFORMATION();

  static vtkInformationRequestKey* REQUEST_RESOLUTION_PROPAGATE();

  static vtkInformationIntegerKey* CONTINUE_EXECUTING();

  static vtkInformationObjectBaseKey* EXTENT_TRANSLATOR();


  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 vtkInformationIntegerKey* UPDATE_AMR_LEVEL();

  static vtkInformationIntegerVectorKey* COMBINED_UPDATE_EXTENT();

  static vtkInformationIntegerKey* UPDATE_EXTENT_TRANSLATED();

  static vtkInformationIntegerVectorKey* WHOLE_EXTENT();

  static vtkInformationIntegerKey* UNRESTRICTED_UPDATE_EXTENT();

  static vtkInformationIntegerKey* MAXIMUM_NUMBER_OF_PIECES();

  static vtkInformationDoubleVectorKey* WHOLE_BOUNDING_BOX();

  static vtkInformationDoubleVectorKey* PIECE_BOUNDING_BOX();

  static vtkInformationDoubleVectorKey* PIECE_NORMAL();

  static vtkInformationIntegerKey* EXACT_EXTENT();

  static vtkInformationDoubleVectorKey* TIME_STEPS();

  static vtkInformationDoubleVectorKey* TIME_RANGE();

  static vtkInformationStringKey* TIME_LABEL_ANNOTATION();

  static vtkInformationDoubleKey* UPDATE_TIME_STEP();

  static vtkInformationIntegerKey* TIME_DEPENDENT_INFORMATION();

  static vtkInformationDoubleKey* PRIORITY();

  static vtkInformationUnsignedLongKey* ORIGINAL_NUMBER_OF_CELLS();

  static vtkInformationDoubleKey* UPDATE_RESOLUTION();

  static vtkInformationIntegerKey* REMOVE_ATTRIBUTE_INFORMATION();

  // Key to allow a reader to advertise that it supports a fast-path
  // for reading data over time.
  static vtkInformationIntegerKey* FAST_PATH_FOR_TEMPORAL_DATA();
  // The type of data being requested.
  // Possible values: POINT, CELL, EDGE, FACE
  static vtkInformationStringKey* FAST_PATH_OBJECT_TYPE();
  // Possible values: INDEX, GLOBAL
  static vtkInformationStringKey* FAST_PATH_ID_TYPE();
  // The id (either index or global id) being requested
  static vtkInformationIdTypeKey* FAST_PATH_OBJECT_ID();


  static vtkInformationDoubleVectorKey *BOUNDS();



  double ComputePriority()
    {
      return this->ComputePriority(0);
    }
  virtual double ComputePriority(int port);

protected:
  vtkStreamingDemandDrivenPipeline();
  ~vtkStreamingDemandDrivenPipeline();


  virtual void ResetUpdateInformation(vtkInformation* request,
    vtkInformationVector** inInfoVec,
    vtkInformationVector* outInfoVec);

  // Keep track of the update time request corresponding to the
  // previous executing. If the previous update request did not
  // correspond to an existing time step and the reader chose
  // a time step with it's own logic, the data time step will
  // be different than the request. If the same time step is
  // requested again, there is no need to re-execute the algorithm.
  // We know that it does not have this time step.
  static vtkInformationDoubleKey* PREVIOUS_UPDATE_TIME_STEP();

  // Keep track of the fast path keys corresponding to the
  // previous executing. If all key values are the same as their
  // counterparts in the previous request, we do not need to re-execute.
  static vtkInformationIdTypeKey* PREVIOUS_FAST_PATH_OBJECT_ID();
  static vtkInformationStringKey* PREVIOUS_FAST_PATH_OBJECT_TYPE();
  static vtkInformationStringKey* PREVIOUS_FAST_PATH_ID_TYPE();

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

  // If the request contains a fast path key for temporal data, always execute
  virtual int NeedToExecuteBasedOnFastPathData(vtkInformation* outInfo);

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

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

  // 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.
  virtual int NeedToExecuteData(int outputPort,
                                vtkInformationVector** inInfoVec,
                                vtkInformationVector* outInfoVec);

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

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


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

  // 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&);  // Not implemented.
  void operator=(const vtkStreamingDemandDrivenPipeline&);  // Not implemented.
};

#endif