## On this page

  

 

 # simulation\_framework::core::ISimRunner Class Reference

 Last update: 16.07.2025 

Interface for controlling and managing simulation execution. [More...](classsimulation__framework_1_1core_1_1ISimRunner.xhtml#details)

`#include <<a class="el" href="i__sim__runner_8h_source.xhtml">i_sim_runner.h</a>>`

Inheritance diagram for simulation_framework::core::ISimRunner:

![Inheritance graph](/sites/default/files/migrate-content/avxcelerate_simulation_framework_2025_r2_2/classsimulation__framework_1_1core_1_1ISimRunner__inherit__graph.png)

\[[legend](graph_legend.xhtml)\]

## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

<a id="a28739232c9e3879e863cd5fa158ef709" name="a28739232c9e3879e863cd5fa158ef709"></a>[virtual](classsimulation__framework_1_1core_1_1Topic.xhtml) **~ISimRunner** ()=[default](classsimulation__framework_1_1core_1_1Topic.xhtml) Virtual destructor for proper cleanup of derived classes.   
 [virtual](classsimulation__framework_1_1core_1_1Topic.xhtml) [StateFeedback](structsimulation__framework_1_1core_1_1StateFeedback.xhtml) [Run](classsimulation__framework_1_1core_1_1ISimRunner.xhtml#ab7615f9b015b1c52e3af9e21ef2bf6ee) ()=0 Starts the simulation.   
 [virtual](classsimulation__framework_1_1core_1_1Topic.xhtml) [StateFeedback](structsimulation__framework_1_1core_1_1StateFeedback.xhtml) [Pause](classsimulation__framework_1_1core_1_1ISimRunner.xhtml#a7cc05d7d61c4cb7af9eca9fb85bce8d7) ()=0 Pauses the simulation.   
 [virtual](classsimulation__framework_1_1core_1_1Topic.xhtml) [StateFeedback](structsimulation__framework_1_1core_1_1StateFeedback.xhtml) [Resume](classsimulation__framework_1_1core_1_1ISimRunner.xhtml#a4b448f77a70ea37643cff04f6d1c7c1c) ()=0 Resumes the simulation if it is paused.   
 [virtual](classsimulation__framework_1_1core_1_1Topic.xhtml) [StateFeedback](structsimulation__framework_1_1core_1_1StateFeedback.xhtml) [StepN](classsimulation__framework_1_1core_1_1ISimRunner.xhtml#a11b61afe9fa80c71aae36c16449ac831) ([int](classsimulation__framework_1_1core_1_1Topic.xhtml) [n](classsimulation__framework_1_1core_1_1Topic.xhtml))=0 Advances the simulation by a specified number of steps.   
 [virtual](classsimulation__framework_1_1core_1_1Topic.xhtml) [StateFeedback](structsimulation__framework_1_1core_1_1StateFeedback.xhtml) [Stop](classsimulation__framework_1_1core_1_1ISimRunner.xhtml#a659d260f4146f46ffe51bc17f93179ac) ()=0 Stops the simulation.   
 [virtual](classsimulation__framework_1_1core_1_1Topic.xhtml) [StateFeedback](structsimulation__framework_1_1core_1_1StateFeedback.xhtml) [Terminate](classsimulation__framework_1_1core_1_1ISimRunner.xhtml#aa5b44639fefef47817aafb6f99719802) ()=0 Terminates the simulation completely.   
 [virtual](classsimulation__framework_1_1core_1_1Topic.xhtml) SimState [GetSimulationState](classsimulation__framework_1_1core_1_1ISimRunner.xhtml#a66d4287f6da13af21331fbfc1c5ff226) () [const](classsimulation__framework_1_1core_1_1Topic.xhtml) =0 Retrieves the current state of the simulation.   
 [virtual](classsimulation__framework_1_1core_1_1Topic.xhtml) [uint64\_t](classsimulation__framework_1_1core_1_1Topic.xhtml) [GetExecutedStepCount](classsimulation__framework_1_1core_1_1ISimRunner.xhtml#ae60fbe830aef619e8cbd39a092f1f995) () [const](classsimulation__framework_1_1core_1_1Topic.xhtml) =0 Retrieves the number of steps executed so far.   
 [virtual](classsimulation__framework_1_1core_1_1Topic.xhtml) [void](classsimulation__framework_1_1core_1_1Topic.xhtml) [RunOverSimulation](classsimulation__framework_1_1core_1_1ISimRunner.xhtml#af5cc40c4bdd9360cd2e95e1c2f8e5626) ()=0 Runs any remaining parts of the simulation to completion.   
 <a id="details" name="details"></a>## Detailed Description

Interface for controlling and managing simulation execution.

The `<a class="el" href="classsimulation__framework_1_1core_1_1ISimRunner.xhtml" title="Interface for controlling and managing simulation execution.">ISimRunner</a>` interface provides a set of external control APIs for managing the lifecycle and execution of a simulation.

Definition at line [41](i__sim__runner_8h_source.xhtml#l00041) of file [i\_sim\_runner.h](i__sim__runner_8h_source.xhtml).



## Member Function Documentation

<a id="ae60fbe830aef619e8cbd39a092f1f995" name="ae60fbe830aef619e8cbd39a092f1f995"></a>## [◆ ](#ae60fbe830aef619e8cbd39a092f1f995)GetExecutedStepCount()

 [virtual](classsimulation__framework_1_1core_1_1Topic.xhtml) [uint64\_t](classsimulation__framework_1_1core_1_1Topic.xhtml) simulation\_framework::core::ISimRunner::GetExecutedStepCount  ( )  const  pure virtual 

Retrieves the number of steps executed so far.

ReturnsThe total number of steps executed as a 64-bit unsigned integer. Implemented in [simulation\_framework::core::SimRunner](classsimulation__framework_1_1core_1_1SimRunner.xhtml#ab7b56bf2aa50f1ca9b14b928268939eb).





<a id="a66d4287f6da13af21331fbfc1c5ff226" name="a66d4287f6da13af21331fbfc1c5ff226"></a>## [◆ ](#a66d4287f6da13af21331fbfc1c5ff226)GetSimulationState()

 [virtual](classsimulation__framework_1_1core_1_1Topic.xhtml) SimState simulation\_framework::core::ISimRunner::GetSimulationState  ( )  const  pure virtual 

Retrieves the current state of the simulation.

ReturnsThe current simulation state as a `SimState` enum value. Implemented in [simulation\_framework::core::SimRunner](classsimulation__framework_1_1core_1_1SimRunner.xhtml#ab5f6d34b0bbd35000cfff95bcfeb901f).





<a id="a7cc05d7d61c4cb7af9eca9fb85bce8d7" name="a7cc05d7d61c4cb7af9eca9fb85bce8d7"></a>## [◆ ](#a7cc05d7d61c4cb7af9eca9fb85bce8d7)Pause()

 [virtual](classsimulation__framework_1_1core_1_1Topic.xhtml) [StateFeedback](structsimulation__framework_1_1core_1_1StateFeedback.xhtml) simulation\_framework::core::ISimRunner::Pause  ( )   pure virtual 

Pauses the simulation.

ReturnsA `<a class="el" href="structsimulation__framework_1_1core_1_1StateFeedback.xhtml" title="Represents feedback for the execution status of a control command.">StateFeedback</a>` object indicating the result of the operation. Implemented in [simulation\_framework::core::SimRunner](classsimulation__framework_1_1core_1_1SimRunner.xhtml#a2008706db821aed76b79bee747a220ac).





<a id="a4b448f77a70ea37643cff04f6d1c7c1c" name="a4b448f77a70ea37643cff04f6d1c7c1c"></a>## [◆ ](#a4b448f77a70ea37643cff04f6d1c7c1c)Resume()

 [virtual](classsimulation__framework_1_1core_1_1Topic.xhtml) [StateFeedback](structsimulation__framework_1_1core_1_1StateFeedback.xhtml) simulation\_framework::core::ISimRunner::Resume  ( )   pure virtual 

Resumes the simulation if it is paused.

ReturnsA `<a class="el" href="structsimulation__framework_1_1core_1_1StateFeedback.xhtml" title="Represents feedback for the execution status of a control command.">StateFeedback</a>` object indicating the result of the operation. Implemented in [simulation\_framework::core::SimRunner](classsimulation__framework_1_1core_1_1SimRunner.xhtml#a0bc52ce914b51ce4fc709b0686d05475).





<a id="ab7615f9b015b1c52e3af9e21ef2bf6ee" name="ab7615f9b015b1c52e3af9e21ef2bf6ee"></a>## [◆ ](#ab7615f9b015b1c52e3af9e21ef2bf6ee)Run()

 [virtual](classsimulation__framework_1_1core_1_1Topic.xhtml) [StateFeedback](structsimulation__framework_1_1core_1_1StateFeedback.xhtml) simulation\_framework::core::ISimRunner::Run  ( )   pure virtual 

Starts the simulation.

ReturnsA `<a class="el" href="structsimulation__framework_1_1core_1_1StateFeedback.xhtml" title="Represents feedback for the execution status of a control command.">StateFeedback</a>` object indicating the result of the operation. Implemented in [simulation\_framework::core::SimRunner](classsimulation__framework_1_1core_1_1SimRunner.xhtml#aa47196cb107ebc1c200ab5fd43fc22f9).





<a id="af5cc40c4bdd9360cd2e95e1c2f8e5626" name="af5cc40c4bdd9360cd2e95e1c2f8e5626"></a>## [◆ ](#af5cc40c4bdd9360cd2e95e1c2f8e5626)RunOverSimulation()

 [virtual](classsimulation__framework_1_1core_1_1Topic.xhtml) [void](classsimulation__framework_1_1core_1_1Topic.xhtml) simulation\_framework::core::ISimRunner::RunOverSimulation  ( )   pure virtual 

Runs any remaining parts of the simulation to completion.

Implemented in [simulation\_framework::core::SimRunner](classsimulation__framework_1_1core_1_1SimRunner.xhtml#a4ba901d04097297295b7b680ac151da9).





<a id="a11b61afe9fa80c71aae36c16449ac831" name="a11b61afe9fa80c71aae36c16449ac831"></a>## [◆ ](#a11b61afe9fa80c71aae36c16449ac831)StepN()

 [virtual](classsimulation__framework_1_1core_1_1Topic.xhtml) [StateFeedback](structsimulation__framework_1_1core_1_1StateFeedback.xhtml) simulation\_framework::core::ISimRunner::StepN  ( [int](classsimulation__framework_1_1core_1_1Topic.xhtml)  *n*)   pure virtual 

Advances the simulation by a specified number of steps.

Parameters nThe number of simulation steps to execute. ReturnsA `<a class="el" href="structsimulation__framework_1_1core_1_1StateFeedback.xhtml" title="Represents feedback for the execution status of a control command.">StateFeedback</a>` object indicating the result of the operation. Implemented in [simulation\_framework::core::SimRunner](classsimulation__framework_1_1core_1_1SimRunner.xhtml#aa2aecf086a4535c9a4d05b977deb29f3).





<a id="a659d260f4146f46ffe51bc17f93179ac" name="a659d260f4146f46ffe51bc17f93179ac"></a>## [◆ ](#a659d260f4146f46ffe51bc17f93179ac)Stop()

 [virtual](classsimulation__framework_1_1core_1_1Topic.xhtml) [StateFeedback](structsimulation__framework_1_1core_1_1StateFeedback.xhtml) simulation\_framework::core::ISimRunner::Stop  ( )   pure virtual 

Stops the simulation.

ReturnsA `<a class="el" href="structsimulation__framework_1_1core_1_1StateFeedback.xhtml" title="Represents feedback for the execution status of a control command.">StateFeedback</a>` object indicating the result of the operation. Implemented in [simulation\_framework::core::SimRunner](classsimulation__framework_1_1core_1_1SimRunner.xhtml#a122aef144fa4620085078b7ef1d58645).





<a id="aa5b44639fefef47817aafb6f99719802" name="aa5b44639fefef47817aafb6f99719802"></a>## [◆ ](#aa5b44639fefef47817aafb6f99719802)Terminate()

 [virtual](classsimulation__framework_1_1core_1_1Topic.xhtml) [StateFeedback](structsimulation__framework_1_1core_1_1StateFeedback.xhtml) simulation\_framework::core::ISimRunner::Terminate  ( )   pure virtual 

Terminates the simulation completely.

ReturnsA `<a class="el" href="structsimulation__framework_1_1core_1_1StateFeedback.xhtml" title="Represents feedback for the execution status of a control command.">StateFeedback</a>` object indicating the result of the operation. Implemented in [simulation\_framework::core::SimRunner](classsimulation__framework_1_1core_1_1SimRunner.xhtml#a6b54a3a3676bc74deea17f50910c3e5b).





---

The documentation for this class was generated from the following file:- [i\_sim\_runner.h](i__sim__runner_8h_source.xhtml)