vtkInSituPipeline.h

Go to the documentation of this file.

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

  Program:   ParaView
  Module:    vtkInSituPipeline.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html 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 vtkInSituPipeline_h
#define vtkInSituPipeline_h

#include "vtkObject.h"
#include "vtkPVInSituModule.h" // For windows import/export of shared libraries

class VTKPVINSITU_EXPORT vtkInSituPipeline : public vtkObject
{
public:
  vtkTypeMacro(vtkInSituPipeline, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual bool Initialize() { return true; }

  /*
   * Called every time a new timestep is produced by the simulation.
   */
  virtual bool Execute(int timestep, double time) = 0;

  virtual bool Finalize() { return true; }

protected:
  vtkInSituPipeline();
  ~vtkInSituPipeline();

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

#endif