vtkDemandDrivenPipeline.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkDemandDrivenPipeline_h
#define vtkDemandDrivenPipeline_h
 
#include "vtkCommonExecutionModelModule.h" // For export macro
#include "vtkExecutive.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkAbstractArray;
class vtkDataArray;
class vtkDataSetAttributes;
class vtkDemandDrivenPipelineInternals;
class vtkFieldData;
class vtkInformation;
class vtkInformationIntegerKey;
class vtkInformationVector;
class vtkInformationKeyVectorKey;
class vtkInformationUnsignedLongKey;

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

  vtkTypeBool ProcessRequest(
    vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo) override;

  int ComputePipelineMTime(vtkInformation* request, vtkInformationVector** inInfoVec,
    vtkInformationVector* outInfoVec, int requestFromOutputPort, vtkMTimeType* mtime) override;


  vtkTypeBool Update() override;
  vtkTypeBool Update(int port) override;


  vtkGetMacro(PipelineMTime, vtkMTimeType);

  virtual int SetReleaseDataFlag(int port, vtkTypeBool n);

  virtual vtkTypeBool GetReleaseDataFlag(int port);

  virtual int UpdatePipelineMTime();

  int UpdateDataObject() override;

  int UpdateInformation() override;

  virtual int UpdateData(int outputPort);

  static vtkInformationRequestKey* REQUEST_DATA_OBJECT();

  static vtkInformationRequestKey* REQUEST_INFORMATION();

  static vtkInformationRequestKey* REQUEST_DATA();

  static vtkInformationRequestKey* REQUEST_DATA_NOT_GENERATED();

  static vtkInformationIntegerKey* RELEASE_DATA();

  static vtkInformationIntegerKey* DATA_NOT_GENERATED();

  static vtkDataObject* NewDataObject(const char* type);
 
protected:
  vtkDemandDrivenPipeline();
  ~vtkDemandDrivenPipeline() override;
 
  // Helper methods to send requests to the algorithm.
  virtual int ExecuteDataObject(
    vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
  virtual int ExecuteInformation(
    vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
  virtual int ExecuteData(
    vtkInformation* request, vtkInformationVector** inInfo, vtkInformationVector* outInfo);
 
  // Reset the pipeline update values in the given output information object.
  void ResetPipelineInformation(int, vtkInformation*) override;
 
  // Check whether the data object in the pipeline information for an
  // output port exists and has a valid type.
  virtual int CheckDataObject(int port, vtkInformationVector* outInfo);
 
  // Input connection validity checkers.
  int InputCountIsValid(vtkInformationVector**);
  int InputCountIsValid(int port, vtkInformationVector**);
  int InputTypeIsValid(vtkInformationVector**);
  int InputTypeIsValid(int port, vtkInformationVector**);
  virtual int InputTypeIsValid(int port, int index, vtkInformationVector**);
  int InputFieldsAreValid(vtkInformationVector**);
  int InputFieldsAreValid(int port, vtkInformationVector**);
  virtual int InputFieldsAreValid(int port, int index, vtkInformationVector**);
 
  // Field existence checkers.
  int DataSetAttributeExists(vtkDataSetAttributes* dsa, vtkInformation* field);
  int FieldArrayExists(vtkFieldData* data, vtkInformation* field);
  int ArrayIsValid(vtkAbstractArray* array, vtkInformation* field);
 
  // Input port information checkers.
  int InputIsOptional(int port);
  int InputIsRepeatable(int port);
 
  // Decide whether the output data need to be generated.
  virtual int NeedToExecuteData(
    int outputPort, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
 
  // Handle before/after operations for ExecuteData method.
  virtual void ExecuteDataStart(
    vtkInformation* request, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
  virtual void ExecuteDataEnd(
    vtkInformation* request, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
  virtual void MarkOutputsGenerated(
    vtkInformation* request, vtkInformationVector** inInfoVec, vtkInformationVector* outInfoVec);
 
  // Largest MTime of any algorithm on this executive or preceding
  // executives.
  vtkMTimeType PipelineMTime;
 
  // Time when information or data were last generated.
  vtkTimeStamp DataObjectTime;
  vtkTimeStamp InformationTime;
  vtkTimeStamp DataTime;
 
  friend class vtkCompositeDataPipeline;
 
  vtkInformation* InfoRequest;
  vtkInformation* DataObjectRequest;
  vtkInformation* DataRequest;
 
private:
  vtkDemandDrivenPipeline(const vtkDemandDrivenPipeline&) = delete;
  void operator=(const vtkDemandDrivenPipeline&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif