vtkDataObjectAlgorithm.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 vtkDataObjectAlgorithm_h
#define vtkDataObjectAlgorithm_h

#include "vtkAlgorithm.h"
#include "vtkCommonExecutionModelModule.h" // For export macro
#include "vtkDataObject.h"                 // makes things a bit easier
#include "vtkWrappingHints.h"              // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkDataSet;
class vtkDataObject;

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


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

  vtkTypeBool ProcessRequest(
    vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;

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


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


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

protected:
  vtkDataObjectAlgorithm();
  ~vtkDataObjectAlgorithm() override;

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

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

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

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

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

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

  static bool SetOutputDataObject(
    int dataType, vtkInformation* outputInformation, bool exact = false);

private:
  vtkDataObjectAlgorithm(const vtkDataObjectAlgorithm&) = delete;
  void operator=(const vtkDataObjectAlgorithm&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif