Computer Assisted Medical Intervention Tool Kit  version 5.2
Simulator.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * $CAMITK_LICENCE_BEGIN$
3  *
4  * CamiTK - Computer Assisted Medical Intervention ToolKit
5  * (c) 2001-2024 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, 38000 Grenoble, France
6  *
7  * Visit http://camitk.imag.fr for more information
8  *
9  * This file is part of CamiTK.
10  *
11  * CamiTK is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * CamiTK is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Lesser General Public License version 3 for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * version 3 along with CamiTK. If not, see <http://www.gnu.org/licenses/>.
22  *
23  * $CAMITK_LICENCE_END$
24  ****************************************************************************/
25 
26 #ifndef SIMULATOR_SIMULATOR_H
27 #define SIMULATOR_SIMULATOR_H
28 
29 #include "MMLAPI.h"
30 // Monitor includes
31 #include "MonitoringManager.h"
32 // Tools includes
33 #include "Macros.h"
34 
35 #ifdef MML_GENERATE_GUI
36 // Simulator includes
37 #include "SimulatorWidget.h"
38 #endif
47 public:
52  Simulator(MonitoringManager* monitoringManager);
59  Simulator(MonitoringManager* monitoringManager, const char* file);
61  virtual ~Simulator() = default;
62 
64  virtual void init() = 0;
66  virtual void end() = 0;
68  void updatePositions();
70  virtual void getPosition(int index, double position[3]) = 0;
72  virtual void getForce(int index, double force[3]) = 0;
73 
75  virtual void createPml(const char* inputFile, const char* pmlFile) = 0;
76 
77 #ifdef MML_GENERATE_GUI
79  QWidget* getWidget();
80 #endif
81 
82 protected:
85 
86 #ifdef MML_GENERATE_GUI
88  SimulatorWidget* widget;
89 #endif
90 
91 };
92 
93 #endif // SIMULATOR_SIMULATOR_H
#define MML_API
Definition: MMLAPI.h:43
Manager of the benchmark tests.
Definition: MonitoringManager.h:50
A widget specific of the simulator to add in the gui all simulator widget have to derive from this cl...
Definition: SimulatorWidget.h:40
A simulator engine is used to compute the displacements of all atoms of the model.
Definition: Simulator.h:46
virtual void getPosition(int index, double position[3])=0
get current position for one atom
MonitoringManager * monitoringManager
monitoring manager
Definition: Simulator.h:84
virtual void getForce(int index, double force[3])=0
get current force for one atom
virtual void init()=0
initialize the simulator
virtual void end()=0
end simultor
virtual void createPml(const char *inputFile, const char *pmlFile)=0
Create a pml file from a simulator specific imput file.
virtual ~Simulator()=default
destructor