## On this page

  

 

 # 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 "core/lifecycle/i\_activity\_factory/i\_activity\_factory.h"

<a id="l00009" name="l00009"></a> 9\#include "core/lifecycle/i\_simulation\_instance/i\_simulation\_instance.h"

<a id="l00010" name="l00010"></a> 10\#include "core/service/parameter/simulation\_parameters.h"

<a id="l00011" name="l00011"></a> 11\#include "core/service/standalone\_activity\_service/standalone\_init\_data/standalone\_init\_data.h"

<a id="l00012" name="l00012"></a> 12\#include "core/time/i\_clock/i\_clock.h"

<a id="l00013" name="l00013"></a> 13\#include "core/time/i\_simulation\_completion\_checker/i\_simulation\_completion\_checker.h"

<a id="l00014" name="l00014"></a> 14 

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

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

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

<a id="l00022" name="l00022"></a> 22{

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

<a id="l00024" name="l00024"></a> 24{

<a id="l00025" name="l00025"></a> 25 

<a id="l00026" name="l00026"></a> 26class SimulationInstanceImpl;

<a id="l00027" name="l00027"></a> 27 

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

<a id="l00033" name="l00033"></a>[ 33](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml)class [SimulationInstance](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml) [final](classsimulation__framework_1_1core_1_1Topic.xhtml) : public [ISimulationInstance](classsimulation__framework_1_1core_1_1lifecycle_1_1ISimulationInstance.xhtml)

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

<a id="l00035" name="l00035"></a> 35 

<a id="l00036" name="l00036"></a> 36 public:

<a id="l00037" name="l00037"></a> 37 [SimulationInstance](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml)(std::unique_ptr&lt;IActivityFactory&gt; [activity\_factory](classsimulation__framework_1_1core_1_1Topic.xhtml),

<a id="l00038" name="l00038"></a> 38 std::shared_ptr&lt;core::time::IClock&gt; [sim\_clock](classsimulation__framework_1_1core_1_1Topic.xhtml),

<a id="l00039" name="l00039"></a> 39 std::unique_ptr&lt;time::ISimulationCompletionChecker&gt; [sim\_state\_checker](classsimulation__framework_1_1core_1_1Topic.xhtml),

<a id="l00040" name="l00040"></a> 40 const core::StandaloneInitData&amp; [standalone\_init\_data](classsimulation__framework_1_1core_1_1Topic.xhtml),

<a id="l00041" name="l00041"></a> 41 const [core::SimulationParameters](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml)&amp; [core\_parameters](classsimulation__framework_1_1core_1_1Topic.xhtml));

<a id="l00042" name="l00042"></a> 42 

<a id="l00043" name="l00043"></a> 43 [~SimulationInstance](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml)();

<a id="l00044" name="l00044"></a> 44 

<a id="l00045" name="l00045"></a>[ 45](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml#a80fd1fe5ea5f8c1187464f0aab2cf035) void [Init](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml#a80fd1fe5ea5f8c1187464f0aab2cf035)() override;

<a id="l00046" name="l00046"></a>[ 46](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml#a4567f8812aa9fb4909191dd0cd78f6d7) void [StepOnce](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml#a4567f8812aa9fb4909191dd0cd78f6d7)() override;

<a id="l00047" name="l00047"></a>[ 47](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml#a7828f047e5aa4ce477b5b3b55d85fe01) void [Reset](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml#a7828f047e5aa4ce477b5b3b55d85fe01)() override;

<a id="l00048" name="l00048"></a>[ 48](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml#ace04d54df178ccb14d5c17817d010489) bool [IsSimulationFinished](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml#ace04d54df178ccb14d5c17817d010489)() override;

<a id="l00049" name="l00049"></a>[ 49](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml#a2d9fb927c4cc2bfe836b2743b547c0a2) std::chrono::milliseconds [GetSimulationDuration](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml#a2d9fb927c4cc2bfe836b2743b547c0a2)() const override;

<a id="l00050" name="l00050"></a>[ 50](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml#af6974f312cdfb505bcb95e6d7e7fa239) std::chrono::milliseconds [GetSimulationBaseCycleTime](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml#af6974f312cdfb505bcb95e6d7e7fa239)() const override;

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

<a id="l00052" name="l00052"></a> 52 private:

<a id="l00053" name="l00053"></a> 53 std::unique_ptr&lt;SimulationInstanceImpl&gt; impl_;

<a id="l00054" name="l00054"></a> 54};



<a id="l00055" name="l00055"></a> 55 

<a id="l00056" name="l00056"></a> 56} // namespace lifecycle

<a id="l00057" name="l00057"></a> 57} // namespace core

<a id="l00058" name="l00058"></a> 58} // namespace simulation\_framework

[simulation\_framework::core::Topic](classsimulation__framework_1_1core_1_1Topic.xhtml)

This is the concrete Topic class that can be used for creation of a communication channel with given ...

**Definition** [topic.h:38](topic_8h_source.xhtml#l00037)



[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::SimulationInstance](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml)

class SimulationInstance

**Definition** [simulation\_instance.h:34](simulation__instance_8h_source.xhtml#l00033)



[simulation\_framework::core::lifecycle::SimulationInstance::GetSimulationDuration](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml#a2d9fb927c4cc2bfe836b2743b547c0a2)

std::chrono::milliseconds GetSimulationDuration() const override

return the duration of the simulation in milliseconds



[simulation\_framework::core::lifecycle::SimulationInstance::StepOnce](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml#a4567f8812aa9fb4909191dd0cd78f6d7)

void StepOnce() override

Step the simulation based on base cycle time.



[simulation\_framework::core::lifecycle::SimulationInstance::Reset](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml#a7828f047e5aa4ce477b5b3b55d85fe01)

void Reset() override

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



[simulation\_framework::core::lifecycle::SimulationInstance::Init](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml#a80fd1fe5ea5f8c1187464f0aab2cf035)

void Init() override

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



[simulation\_framework::core::lifecycle::SimulationInstance::IsSimulationFinished](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml#ace04d54df178ccb14d5c17817d010489)

bool IsSimulationFinished() override

indicates whether this run if simulation reaches the end



[simulation\_framework::core::lifecycle::SimulationInstance::GetSimulationBaseCycleTime](classsimulation__framework_1_1core_1_1lifecycle_1_1SimulationInstance.xhtml#af6974f312cdfb505bcb95e6d7e7fa239)

std::chrono::milliseconds GetSimulationBaseCycleTime() const override

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



[core](namespacecore.xhtml)

The namespace for all core functionalities under namespace simulation_framework.



[simulation\_framework](namespacesimulation__framework.xhtml)

The top namespace for simulation framework.



[simulation\_framework::core::SimulationParameters](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml)

The SimulationParameters struct encapsulates parameters related to simfwk-core configuration.

**Definition** [simulation\_parameters.h:29](simulation__parameters_8h_source.xhtml#l00028)