Computer Assisted Medical Intervention Tool Kit  version 5.2
InteractiveSimulator Class Referenceabstract

An interactive simulator is a simulator that we can control step by step (ex: Sofa) More...

#include <InteractiveSimulator.h>

+ Inheritance diagram for InteractiveSimulator:
+ Collaboration diagram for InteractiveSimulator:

Public Member Functions

void createPml (const char *inputFile, const char *pmlFile) override=0
 Create a pml file from an imput file. More...
 
virtual void doMove (double dt)=0
 ask the simulator do to one step of the simulation More...
 
void end () override=0
 end simultor More...
 
void getPosition (int index, double position[3]) override=0
 get current position for one atom More...
 
void init () override=0
 initialize the simulator More...
 
 InteractiveSimulator (MonitoringManager *monitoringManager)
 constructor More...
 
 InteractiveSimulator (MonitoringManager *monitoringManager, const char *file)
 constructor More...
 
 ~InteractiveSimulator () override=default
 destructor More...
 
- Public Member Functions inherited from Simulator
virtual void getForce (int index, double force[3])=0
 get current force for one atom More...
 
 Simulator (MonitoringManager *monitoringManager)
 default constructor build a simulation from context provided by monitoringManager More...
 
 Simulator (MonitoringManager *monitoringManager, const char *file)
 constructor with simulator file build a simulation from context provided by monitoringManager and physical model provided by a simulator specific input file More...
 
void updatePositions ()
 update all current positions and store last positions More...
 
virtual ~Simulator ()=default
 destructor More...
 

Additional Inherited Members

- Protected Attributes inherited from Simulator
MonitoringManagermonitoringManager
 monitoring manager More...
 

Detailed Description

An interactive simulator is a simulator that we can control step by step (ex: Sofa)

Constructor & Destructor Documentation

◆ InteractiveSimulator() [1/2]

InteractiveSimulator::InteractiveSimulator ( MonitoringManager monitoringManager)

constructor

◆ InteractiveSimulator() [2/2]

InteractiveSimulator::InteractiveSimulator ( MonitoringManager monitoringManager,
const char *  file 
)

constructor

◆ ~InteractiveSimulator()

InteractiveSimulator::~InteractiveSimulator ( )
overridedefault

destructor

Member Function Documentation

◆ createPml()

void InteractiveSimulator::createPml ( const char *  inputFile,
const char *  pmlFile 
)
overridepure virtual

Create a pml file from an imput file.

Implements Simulator.

Implemented in SofaSimulator.

◆ doMove()

virtual void InteractiveSimulator::doMove ( double  dt)
pure virtual

ask the simulator do to one step of the simulation

Parameters
dtintegration step

Implemented in SofaSimulator.

Referenced by InteractiveMonitoringManager::doMove().

+ Here is the caller graph for this function:

◆ end()

void InteractiveSimulator::end ( )
overridepure virtual

end simultor

Implements Simulator.

Implemented in SofaSimulator.

Referenced by InteractiveMonitoringManager::end().

+ Here is the caller graph for this function:

◆ getPosition()

void InteractiveSimulator::getPosition ( int  index,
double  position[3] 
)
overridepure virtual

get current position for one atom

Implements Simulator.

Implemented in SofaSimulator.

◆ init()

void InteractiveSimulator::init ( )
overridepure virtual

initialize the simulator

Implements Simulator.

Implemented in SofaSimulator.

Referenced by InteractiveMonitoringManager::init().

+ Here is the caller graph for this function:

The documentation for this class was generated from the following files: