dox/Filtering/vtkStructuredGridAlgorithm.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkStructuredGridAlgorithm.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 __vtkStructuredGridAlgorithm_h
#define __vtkStructuredGridAlgorithm_h

#include "vtkAlgorithm.h"
#include "vtkStructuredGrid.h" // makes things a bit easier

class vtkDataSet;
class vtkStructuredGrid;

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


  vtkStructuredGrid* GetOutput();
  vtkStructuredGrid* GetOutput(int);
  virtual void SetOutput(vtkDataObject* d);


  virtual int ProcessRequest(vtkInformation*,
                             vtkInformationVector**,
                             vtkInformationVector*);

  // this method is not recommended for use, but lots of old style filters
  // use it
  vtkDataObject* GetInput();
  vtkDataObject *GetInput(int port);
  vtkStructuredGrid *GetStructuredGridInput(int port);


  void SetInput(vtkDataObject *);
  void SetInput(int, vtkDataObject*);


  void AddInput(vtkDataObject *);
  void AddInput(int, vtkDataObject*);

protected:
  vtkStructuredGridAlgorithm();
  ~vtkStructuredGridAlgorithm();

  // convenience method
  virtual int RequestInformation(vtkInformation* request,
                                 vtkInformationVector** inputVector,
                                 vtkInformationVector* outputVector);


  virtual int RequestData(vtkInformation* request,
                          vtkInformationVector** inputVector,
                          vtkInformationVector* outputVector);


  virtual int RequestUpdateExtent(vtkInformation*,
                                  vtkInformationVector**,
                                  vtkInformationVector*)
    {
      return 1;
    };


  virtual void ExecuteData(vtkDataObject *output);
  virtual void Execute();

  // see algorithm for more info
  virtual int FillOutputPortInformation(int port, vtkInformation* info);
  virtual int FillInputPortInformation(int port, vtkInformation* info);

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

#endif