vtkAlgorithm.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    $RCSfile: vtkAlgorithm.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 __vtkAlgorithm_h
#define __vtkAlgorithm_h

#include "vtkObject.h"

class vtkAlgorithmInternals;
class vtkAlgorithmOutput;
class vtkDataObject;
class vtkExecutive;
class vtkInformation;
class vtkInformationInformationVectorKey;
class vtkInformationIntegerKey;
class vtkInformationStringKey;
class vtkInformationVector;

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

  int HasExecutive();

  vtkExecutive* GetExecutive();

  virtual void SetExecutive(vtkExecutive* executive);


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

  vtkInformation* GetInputPortInformation(int port);


  vtkInformation* GetInputConnectionInformation(vtkInformationVector *inInfo,
                                                int port, int connection);
  
  vtkInformation* GetOutputPortInformation(int port);


  vtkGetObjectMacro(Information, vtkInformation);
  virtual void SetInformation(vtkInformation*);

  vtkDataObject* GetOutputDataObject(int port);

  virtual void SetInputConnection(int port, vtkAlgorithmOutput* input);

  virtual void AddInputConnection(int port, vtkAlgorithmOutput* input);

  virtual void RemoveInputConnection(int port, vtkAlgorithmOutput* input);

  vtkAlgorithmOutput* GetOutputPort(int index);

  int GetNumberOfInputPorts();

  int GetNumberOfOutputPorts();

  int GetNumberOfInputConnections(int port);

  int GetTotalNumberOfInputConnections();

  vtkAlgorithmOutput* GetInputConnection(int port, int index);

  virtual void Update();

  virtual void UpdateInformation();

  virtual void UpdateWholeExtent();

  virtual void UnRegister(vtkObjectBase* o);


  vtkSetMacro(AbortExecute,int);
  vtkGetMacro(AbortExecute,int);
  vtkBooleanMacro(AbortExecute,int);


  vtkSetClampMacro(Progress,double,0.0,1.0);
  vtkGetMacro(Progress,double);

  void UpdateProgress(double amount);


  vtkSetStringMacro(ProgressText);
  vtkGetStringMacro(ProgressText);

  // left public for performance since it is used in inner loops
  int AbortExecute;


  static vtkInformationIntegerKey* INPUT_IS_OPTIONAL();
  static vtkInformationIntegerKey* INPUT_IS_REPEATABLE();
  static vtkInformationInformationVectorKey* INPUT_CONNECTION_INFORMATION();
  static vtkInformationInformationVectorKey* INPUT_REQUIRED_FIELDS();
  static vtkInformationStringKey* INPUT_REQUIRED_DATA_TYPE();

  void ConvertTotalInputToPortConnection(int ind, int &port, int &conn);
  

  //======================================================================
  //The followling block of code is to support old style VTK applications. If
  //you are using these calls there are better ways to do it in the new
  //pipeline
  //======================================================================
  

  void ReleaseDataFlagOn();
  void ReleaseDataFlagOff();

  //========================================================================
  
protected:
  vtkAlgorithm();
  ~vtkAlgorithm();

  // Arbitrary extra information associated with this algorithm
  vtkInformation* Information;

  virtual int FillInputPortInformation(int port, vtkInformation* info);

  virtual int FillOutputPortInformation(int port, vtkInformation* info);

  virtual void SetNumberOfInputPorts(int n);

  virtual void SetNumberOfOutputPorts(int n);

  // Helper methods to check input/output port index ranges.
  int InputPortIndexInRange(int index, const char* action);
  int OutputPortIndexInRange(int index, const char* action);

  void SetNthInputConnection(int port, int index, vtkAlgorithmOutput* input);

  // Create a default executive.
  virtual vtkExecutive* CreateDefaultExecutive();

  // Progress/Update handling
  double Progress;
  char  *ProgressText;

  // Garbage collection support.
  virtual void ReportReferences(vtkGarbageCollector*);
  virtual void RemoveReferences();
  virtual void GarbageCollectionStarting();
  int GarbageCollecting;
private:
  vtkAlgorithmInternals* AlgorithmInternal;
  static void ConnectionAdd(vtkAlgorithm* producer, int producerPort,
                            vtkAlgorithm* consumer, int consumerPort);
  static void ConnectionRemove(vtkAlgorithm* producer, int producerPort,
                               vtkAlgorithm* consumer, int consumerPort);
  static void ConnectionRemoveAllInput(vtkAlgorithm* consumer, int port);
  static void ConnectionRemoveAllOutput(vtkAlgorithm* producer, int port);

private:
  vtkAlgorithm(const vtkAlgorithm&);  // Not implemented.
  void operator=(const vtkAlgorithm&);  // Not implemented.
};

#endif

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