## On this page

  

 

 # simulation\_parameters

 Last update: 16.07.2025 

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

<a id="l00003" name="l00003"></a> 3 

<a id="l00004" name="l00004"></a> 4\#pragma once

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

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

<a id="l00007" name="l00007"></a> 7\#include &lt;string&gt;

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

<a id="l00009" name="l00009"></a> 9 

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

<a id="l00015" name="l00015"></a> 15{

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

<a id="l00017" name="l00017"></a> 17{

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

<a id="l00019" name="l00019"></a> 19struct File

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

<a id="l00021" name="l00021"></a> 21 std::string name;

<a id="l00022" name="l00022"></a> 22 std::string path;

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

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

<a id="l00028" name="l00028"></a>[ 28](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml)struct [SimulationParameters](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml)

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

<a id="l00033" name="l00033"></a>[ 33](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a394360d7e19a61151974fa528f4f1a2a) std::string [version](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a394360d7e19a61151974fa528f4f1a2a);

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

<a id="l00038" name="l00038"></a>[ 38](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a394b1d58a15a471682013c63f4e37d13) std::string [log\_level](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a394b1d58a15a471682013c63f4e37d13);

<a id="l00039" name="l00039"></a> 39 

<a id="l00043" name="l00043"></a>[ 43](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a1d05a88de7c8c3ff63adf06a52f53c7d) std::string [id](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a1d05a88de7c8c3ff63adf06a52f53c7d);

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

<a id="l00049" name="l00049"></a>[ 49](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a2714b6d1f312742f94dc3222ac760fa9) std::string [simulation\_config](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a2714b6d1f312742f94dc3222ac760fa9);

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

<a id="l00054" name="l00054"></a>[ 54](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#ad04340b459fca0559a426a198593af73) std::string [scheduling\_config](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#ad04340b459fca0559a426a198593af73);

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

<a id="l00059" name="l00059"></a>[ 59](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a3dc188eb45de6e1481b6ce35ce773588) std::string [output\_directory](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a3dc188eb45de6e1481b6ce35ce773588);

<a id="l00060" name="l00060"></a> 60 

<a id="l00064" name="l00064"></a>[ 64](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#ad709bca5eef2d162f97b3c7f07df900b) std::vector&lt;File&gt; [input\_files](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#ad709bca5eef2d162f97b3c7f07df900b);

<a id="l00065" name="l00065"></a> 65 

<a id="l00069" name="l00069"></a>[ 69](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#af8a90b2bef8680b69a15813e60c93404) std::string [cli\_control\_grpc\_address](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#af8a90b2bef8680b69a15813e60c93404);

<a id="l00070" name="l00070"></a> 70 

<a id="l00074" name="l00074"></a>[ 74](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a0b5db8592c55e9a1c4eb17eae6d23283) bool [cli\_control\_mode\_enabled](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a0b5db8592c55e9a1c4eb17eae6d23283);

<a id="l00075" name="l00075"></a> 75 

<a id="l00079" name="l00079"></a>[ 79](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a234596a492675e46f8c4c0900768093d) std::chrono::milliseconds [scheduler\_event\_timeout](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a234596a492675e46f8c4c0900768093d);

<a id="l00080" name="l00080"></a> 80 

<a id="l00084" name="l00084"></a>[ 84](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#aca58e1bd9cc396ed5b520495c61f818a) float [timescale\_factor](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#aca58e1bd9cc396ed5b520495c61f818a);

<a id="l00085" name="l00085"></a> 85};



<a id="l00086" name="l00086"></a> 86 

<a id="l00087" name="l00087"></a> 87} // namespace core

<a id="l00088" name="l00088"></a> 88} // namespace simulation\_framework

[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)



[simulation\_framework::core::SimulationParameters::cli\_control\_mode\_enabled](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a0b5db8592c55e9a1c4eb17eae6d23283)

bool cli_control_mode_enabled

A boolean indicating whether CLI control mode is enabled.

**Definition** [simulation\_parameters.h:74](simulation__parameters_8h_source.xhtml#l00074)



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

std::string id

A string indicating a unique ID for the simulation.

**Definition** [simulation\_parameters.h:43](simulation__parameters_8h_source.xhtml#l00043)



[simulation\_framework::core::SimulationParameters::scheduler\_event\_timeout](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a234596a492675e46f8c4c0900768093d)

std::chrono::milliseconds scheduler_event_timeout

A duration representing the timeout for scheduler events, expressed in milliseconds.

**Definition** [simulation\_parameters.h:79](simulation__parameters_8h_source.xhtml#l00079)



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

std::string simulation_config

A string indicating the path to the simulation configuration file for your built simulation applicati...

**Definition** [simulation\_parameters.h:49](simulation__parameters_8h_source.xhtml#l00049)



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

std::string version

version A string representing the version of the simulation.

**Definition** [simulation\_parameters.h:33](simulation__parameters_8h_source.xhtml#l00033)



[simulation\_framework::core::SimulationParameters::log\_level](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a394b1d58a15a471682013c63f4e37d13)

std::string log_level

A string indicating the logging level for the simulation.

**Definition** [simulation\_parameters.h:38](simulation__parameters_8h_source.xhtml#l00038)



[simulation\_framework::core::SimulationParameters::output\_directory](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a3dc188eb45de6e1481b6ce35ce773588)

std::string output_directory

A string indicating the path where simulation shall dump out files.

**Definition** [simulation\_parameters.h:59](simulation__parameters_8h_source.xhtml#l00059)



[simulation\_framework::core::SimulationParameters::timescale\_factor](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#aca58e1bd9cc396ed5b520495c61f818a)

float timescale_factor

A floating-point value representing the timescale factor for simulation time.

**Definition** [simulation\_parameters.h:84](simulation__parameters_8h_source.xhtml#l00084)



[simulation\_framework::core::SimulationParameters::scheduling\_config](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#ad04340b459fca0559a426a198593af73)

std::string scheduling_config

A string containing the scheduling configuration file path for the simulation.

**Definition** [simulation\_parameters.h:54](simulation__parameters_8h_source.xhtml#l00054)



[simulation\_framework::core::SimulationParameters::input\_files](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#ad709bca5eef2d162f97b3c7f07df900b)

std::vector&lt; File &gt; input_files

A vector of File which simulation uses as input.

**Definition** [simulation\_parameters.h:64](simulation__parameters_8h_source.xhtml#l00064)



[simulation\_framework::core::SimulationParameters::cli\_control\_grpc\_address](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#af8a90b2bef8680b69a15813e60c93404)

std::string cli_control_grpc_address

A string specifying the gRPC address for CLI (Command Line Interface) control.

**Definition** [simulation\_parameters.h:69](simulation__parameters_8h_source.xhtml#l00069)