vtkDemandDrivenPipeline.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    $RCSfile: vtkDemandDrivenPipeline.h,v $

  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 __vtkDemandDrivenPipeline_h
#define __vtkDemandDrivenPipeline_h

#include "vtkDistributedExecutive.h"

class vtkDataArray;
class vtkDataSetAttributes;
class vtkDemandDrivenPipelineInternals;
class vtkFieldData;
class vtkInformation;
class vtkInformationIntegerKey;
class vtkInformationVector;
class vtkInformationKeyVectorKey;

class VTK_FILTERING_EXPORT vtkDemandDrivenPipeline : public vtkDistributedExecutive
{
public:
  static vtkDemandDrivenPipeline* New();
  vtkTypeRevisionMacro(vtkDemandDrivenPipeline,vtkDistributedExecutive);
  void PrintSelf(ostream& os, vtkIndent indent);


  virtual int Update();
  virtual int Update(int port);
  virtual int Update(vtkAlgorithm* algorithm);
  virtual int Update(vtkAlgorithm* algorithm, int port);


  virtual vtkInformation* GetOutputInformation(int port);
  virtual vtkInformation* GetOutputInformation(vtkAlgorithm* algorithm,
                                               int port);


  vtkGetMacro(PipelineMTime, unsigned long);
    

  virtual vtkDataObject* GetOutputData(int port);
  virtual vtkDataObject* GetOutputData(vtkAlgorithm* algorithm, int port);
  virtual void SetOutputData(int port, vtkDataObject*);
  virtual void SetOutputData(vtkAlgorithm* algorithm, int port, vtkDataObject*);


  virtual vtkDataObject* GetInputData(vtkAlgorithm* algorithm, 
                                      int port, int connection);
  virtual vtkDataObject* GetInputData(int port, int connection);

  virtual int SetReleaseDataFlag(int port, int n);

  virtual int GetReleaseDataFlag(int port);

  static vtkInformationKeyVectorKey* DOWNSTREAM_KEYS_TO_COPY();
  static vtkInformationIntegerKey* REQUEST_DATA_OBJECT();
  static vtkInformationIntegerKey* REQUEST_INFORMATION();
  static vtkInformationIntegerKey* REQUEST_DATA();
  static vtkInformationIntegerKey* FROM_OUTPUT_PORT();
  static vtkInformationIntegerKey* RELEASE_DATA();

  virtual int UpdateDataObject();
  virtual int UpdateInformation();
  virtual int UpdateData(int outputPort);

  vtkDemandDrivenPipeline* GetConnectedInputExecutive(int port, int index);
  vtkInformation* GetConnectedInputInformation(int port, int index);

protected:
  vtkDemandDrivenPipeline();
  ~vtkDemandDrivenPipeline();

  virtual int ExecuteDataObject();
  virtual int ExecuteInformation();
  virtual int ExecuteData(int outputPort);

  // Put default information in output information objects.
  virtual void FillDefaultOutputInformation(int port, vtkInformation*);

  // Reset the pipeline update values in the given output information object.
  virtual void ResetPipelineInformation(int port, vtkInformation*);


  vtkInformation* GetRequestInformation();
  vtkInformationVector* GetInputInformation();
  vtkInformation* GetInputInformation(int port);
  vtkInformationVector* GetOutputInformation();

  void PrepareDownstreamRequest(vtkInformationIntegerKey* rkey);
  void PrepareUpstreamRequest(vtkInformationIntegerKey* rkey);
  virtual void CopyDefaultDownstreamInformation();
  virtual int CheckDataObject(int port);

  // Input connection validity checkers.
  int InputCountIsValid();
  int InputCountIsValid(int port);
  int InputTypeIsValid();
  int InputTypeIsValid(int port);
  int InputTypeIsValid(int port, int index);
  int InputFieldsAreValid();
  int InputFieldsAreValid(int port);
  int InputFieldsAreValid(int port, int index);

  // Field existence checkers.
  int DataSetAttributeExists(vtkDataSetAttributes* dsa, vtkInformation* field);
  int FieldArrayExists(vtkFieldData* data, vtkInformation* field);
  int ArrayIsValid(vtkDataArray* array, vtkInformation* field);

  // Input port information checkers.
  int InputIsOptional(int port);
  int InputIsRepeatable(int port);

  vtkDataObject* NewDataObject(const char* type);

  // Support garbage collection.
  virtual void ReportReferences(vtkGarbageCollector*);
  virtual void RemoveReferences();

  // Decide whether the output data need to be generated.
  virtual int NeedToExecuteData(int outputPort);

  // Largest MTime of any algorithm on this executive or preceding
  // executives.
  unsigned long PipelineMTime;

  // Time when information or data were last generated.
  vtkTimeStamp DataObjectTime;
  vtkTimeStamp InformationTime;
  vtkTimeStamp DataTime;

  int InProcessRequest;

private:
  vtkDemandDrivenPipelineInternals* DemandDrivenInternal;

  vtkDemandDrivenPipeline(const vtkDemandDrivenPipeline&);  // Not implemented.
  void operator=(const vtkDemandDrivenPipeline&);  // Not implemented.
};

#endif

Generated on Tue Oct 5 08:38:57 2004 for VTK by Doxygen 1.3.8-20040913