vtkInSituPipeline.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
2 // SPDX-License-Identifier: BSD-3-Clause
29 #ifndef vtkInSituPipeline_h
30 #define vtkInSituPipeline_h
31 
32 #include "vtkObject.h"
33 #include "vtkPVInSituModule.h" // For windows import/export of shared libraries
34 
35 class VTKPVINSITU_EXPORT vtkInSituPipeline : public vtkObject
36 {
37 public:
38  vtkTypeMacro(vtkInSituPipeline, vtkObject);
39  void PrintSelf(ostream& os, vtkIndent indent) override;
40 
44  virtual bool Initialize() { return true; }
45 
46  /*
47  * Called every time a new timestep is produced by the simulation.
48  */
49  virtual bool Execute(int timestep, double time) = 0;
50 
54  virtual bool Finalize() { return true; }
55 
60  vtkSetStringMacro(Name);
61  vtkGetStringMacro(Name);
62 
63 protected:
65  ~vtkInSituPipeline() override;
66 
67  char* Name;
68 
69 private:
70  vtkInSituPipeline(const vtkInSituPipeline&) = delete;
71  void operator=(const vtkInSituPipeline&) = delete;
72 };
73 
74 #endif
vtkObjectBase::operator=
void operator=(const vtkObjectBase &)
vtkInSituPipeline::Initialize
virtual bool Initialize()
Initialize is called once before the first call to 'Execute'.
Definition: vtkInSituPipeline.h:44
vtkObject
vtkInSituPipeline
abstract base class for all in situ pipelines.
Definition: vtkInSituPipeline.h:35
vtkInSituPipeline::Name
char * Name
Definition: vtkInSituPipeline.h:67
vtkIndent
vtkObject.h
vtkObject::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) VTK_OVERRIDE
vtkInSituPipeline::Finalize
virtual bool Finalize()
Called once before the in situ analysis is finalized.
Definition: vtkInSituPipeline.h:54