1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkProcess
* @brief a process that can be launched by a vtkMultiProcessController
*
* vtkProcess is an abstract class representing a process that can be launched
* by a vtkMultiProcessController. Concrete classes just have to implement
* Execute() method and make sure it set the proper value in ReturnValue.
*
* @par Example:
* class MyProcess: public vtkProcess
* ...
* vtkMultiProcessController *c;
* MyProcess *p=new MyProcess::New();
* p->SetArgs(argc,argv); // some parameters specific to the process
* p->SetX(10.0); // ...
* c->SetSingleProcess(p);
* c->SingleMethodExecute();
* int returnValue=p->GetReturnValue();
*
* @sa
* vtkMultiProcessController
*/
#ifndef vtkProcess_h
#define vtkProcess_h
#include "vtkObject.h"
#include "vtkParallelCoreModule.h" // For export macro
VTK_ABI_NAMESPACE_BEGIN
class vtkMultiProcessController;
class VTKPARALLELCORE_EXPORT vtkProcess : public vtkObject
{
public:
vtkTypeMacro(vtkProcess, vtkObject);
void PrintSelf(ostream& os, vtkIndent indent) override;
/**
* Entry point of the process.
* This method is expected to update ReturnValue.
*/
virtual void Execute() = 0;
/**
* Give access to the controller that launched the process.
* Initial value is nullptr.
*/
vtkMultiProcessController* GetController();
/**
* This method should not be called directly but set by the controller
* itself.
*/
void SetController(vtkMultiProcessController* aController);
/**
* Value set at the end of a call to Execute.
*/
int GetReturnValue();
protected:
vtkProcess();
~vtkProcess() override;
vtkMultiProcessController* Controller;
int ReturnValue;
private:
vtkProcess(const vtkProcess&) = delete;
void operator=(const vtkProcess&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif
|