## On this page

  

 

 # i\_simulation\_instance

 Last update: 16.07.2025 

<a id="l00001" name="l00001"></a> 1 

<a id="l00005" name="l00005"></a> 5 

<a id="l00006" name="l00006"></a> 6\#pragma once

<a id="l00007" name="l00007"></a> 7 

<a id="l00008" name="l00008"></a> 8\#include &lt;chrono&gt;

<a id="l00009" name="l00009"></a> 9\#include &lt;memory&gt;

<a id="l00010" name="l00010"></a> 10 

<a id="l00015" name="l00015"></a> 15namespace [simulation\_framework](namespacesimulation__framework.xhtml)

<a id="l00016" name="l00016"></a> 16{

<a id="l00017" name="l00017"></a> 17namespace [core](namespacecore.xhtml)

<a id="l00018" name="l00018"></a> 18{

<a id="l00019" name="l00019"></a> 19namespace lifecycle

<a id="l00020" name="l00020"></a> 20{

<a id="l00021" name="l00021"></a> 21 

<a id="l00023" name="l00023"></a> 23 

<a id="l00027" name="l00027"></a>[ 27](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml)class [ISimulationInstance](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml)

<a id="l00028" name="l00028"></a> 28{

<a id="l00029" name="l00029"></a> 29 public:

<a id="l00030" name="l00030"></a> 30 virtual [~ISimulationInstance](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml)() = default;

<a id="l00031" name="l00031"></a> 31 

<a id="l00033" name="l00033"></a>[ 33](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml#a80cbbbd41aa237e59428d0becfe1dc0d) virtual void [StepOnce](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml#a80cbbbd41aa237e59428d0becfe1dc0d)() = 0;

<a id="l00034" name="l00034"></a> 34 

<a id="l00036" name="l00036"></a>[ 36](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml#a5cdfd3b69391a260cdc1611cf4b5adff) virtual void [Reset](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml#a5cdfd3b69391a260cdc1611cf4b5adff)() = 0;

<a id="l00037" name="l00037"></a> 37 

<a id="l00039" name="l00039"></a>[ 39](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml#a871729a4dedeafe05c8bece8d1792e0d) virtual void [Init](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml#a871729a4dedeafe05c8bece8d1792e0d)() = 0;

<a id="l00040" name="l00040"></a> 40 

<a id="l00042" name="l00042"></a>[ 42](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml#ac7571086e9a65bb13fef8dd79d94edba) virtual bool [IsSimulationFinished](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml#ac7571086e9a65bb13fef8dd79d94edba)() = 0;

<a id="l00043" name="l00043"></a> 43 

<a id="l00045" name="l00045"></a>[ 45](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml#a490a9b9214cd38ae2405bd326a30a6af) virtual std::chrono::milliseconds [GetSimulationDuration](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml#a490a9b9214cd38ae2405bd326a30a6af)() const = 0;

<a id="l00046" name="l00046"></a> 46 

<a id="l00049" name="l00049"></a>[ 49](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml#a99d8248ac91814b9503b4ba7301723fc) virtual std::chrono::milliseconds [GetSimulationBaseCycleTime](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml#a99d8248ac91814b9503b4ba7301723fc)() const = 0;

<a id="l00050" name="l00050"></a> 50};



<a id="l00051" name="l00051"></a> 51 

<a id="l00052" name="l00052"></a> 52} // namespace lifecycle

<a id="l00053" name="l00053"></a> 53} // namespace core

<a id="l00054" name="l00054"></a> 54} // namespace simulation\_framework

[simulation\_framework::core::lifecycle::ISimulationInstance](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml)

class ISimulationInstance

**Definition** [i\_simulation\_instance.h:28](i__simulation__instance_8h_source.xhtml#l00027)



[simulation\_framework::core::lifecycle::ISimulationInstance::GetSimulationDuration](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml#a490a9b9214cd38ae2405bd326a30a6af)

virtual std::chrono::milliseconds GetSimulationDuration() const =0

return the duration of the simulation in milliseconds



[simulation\_framework::core::lifecycle::ISimulationInstance::Reset](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml#a5cdfd3b69391a260cdc1611cf4b5adff)

virtual void Reset()=0

provides the reset to SimRunner to let the simulation back to init state



[simulation\_framework::core::lifecycle::ISimulationInstance::StepOnce](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml#a80cbbbd41aa237e59428d0becfe1dc0d)

virtual void StepOnce()=0

Step the simulation based on base cycle time.



[simulation\_framework::core::lifecycle::ISimulationInstance::Init](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml#a871729a4dedeafe05c8bece8d1792e0d)

virtual void Init()=0

Initialize based on user config and turn the instance to ready state.



[simulation\_framework::core::lifecycle::ISimulationInstance::GetSimulationBaseCycleTime](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml#a99d8248ac91814b9503b4ba7301723fc)

virtual std::chrono::milliseconds GetSimulationBaseCycleTime() const =0

return the base cycle time of the simulation in milliseconds, which usually is the greatest common di...



[simulation\_framework::core::lifecycle::ISimulationInstance::IsSimulationFinished](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml#ac7571086e9a65bb13fef8dd79d94edba)

virtual bool IsSimulationFinished()=0

indicates whether this run if simulation reaches the end



[core](namespacecore.xhtml)

The namespace for all core functionalities under namespace simulation_framework.



[simulation\_framework](namespacesimulation__framework.xhtml)

The top namespace for simulation framework.