## On this page

  

 

 # simulation\_framework::core::SimulationParameters Struct Reference

 Last update: 16.07.2025 

The [SimulationParameters](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml "The SimulationParameters struct encapsulates parameters related to simfwk-core configuration.") struct encapsulates parameters related to simfwk-core configuration. [More...](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#details)

`#include <<a class="el" href="simulation__parameters_8h_source.xhtml">simulation_parameters.h</a>>`

## <a id="pub-attribs" name="pub-attribs"></a>Public Attributes

std::string [version](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a394360d7e19a61151974fa528f4f1a2a) version A string representing the version of the simulation.   
 std::string [log\_level](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a394b1d58a15a471682013c63f4e37d13) A string indicating the logging level for the simulation.   
 std::string [id](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a1d05a88de7c8c3ff63adf06a52f53c7d) A string indicating a unique ID for the simulation.   
 std::string [simulation\_config](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a2714b6d1f312742f94dc3222ac760fa9) A string indicating the path to the simulation configuration file for your built simulation application.   
 std::string [scheduling\_config](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#ad04340b459fca0559a426a198593af73) A string containing the scheduling configuration file path for the simulation.   
 std::string [output\_directory](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a3dc188eb45de6e1481b6ce35ce773588) A string indicating the path where simulation shall dump out files.   
 std::vector&lt; File &gt; [input\_files](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#ad709bca5eef2d162f97b3c7f07df900b) A vector of File which simulation uses as input.   
 std::string [cli\_control\_grpc\_address](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#af8a90b2bef8680b69a15813e60c93404) A string specifying the gRPC address for CLI (Command Line Interface) control.   
 [bool](classsimulation__framework_1_1core_1_1Topic.xhtml) [cli\_control\_mode\_enabled](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a0b5db8592c55e9a1c4eb17eae6d23283) A boolean indicating whether CLI control mode is enabled.   
 std::chrono::milliseconds [scheduler\_event\_timeout](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#a234596a492675e46f8c4c0900768093d) A duration representing the timeout for scheduler events, expressed in milliseconds.   
 [float](classsimulation__framework_1_1core_1_1Topic.xhtml) [timescale\_factor](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml#aca58e1bd9cc396ed5b520495c61f818a) A floating-point value representing the timescale factor for simulation time.   
 <a id="details" name="details"></a>## Detailed Description

The [SimulationParameters](structsimulation__framework_1_1core_1_1SimulationParameters.xhtml "The SimulationParameters struct encapsulates parameters related to simfwk-core configuration.") struct encapsulates parameters related to simfwk-core configuration.

Definition at line [28](simulation__parameters_8h_source.xhtml#l00028) of file [simulation\_parameters.h](simulation__parameters_8h_source.xhtml).



## Member Data Documentation

<a id="af8a90b2bef8680b69a15813e60c93404" name="af8a90b2bef8680b69a15813e60c93404"></a>## [◆ ](#af8a90b2bef8680b69a15813e60c93404)cli\_control\_grpc\_address

 std::string simulation\_framework::core::SimulationParameters::cli\_control\_grpc\_address

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

Definition at line [69](simulation__parameters_8h_source.xhtml#l00069) of file [simulation\_parameters.h](simulation__parameters_8h_source.xhtml).





<a id="a0b5db8592c55e9a1c4eb17eae6d23283" name="a0b5db8592c55e9a1c4eb17eae6d23283"></a>## [◆ ](#a0b5db8592c55e9a1c4eb17eae6d23283)cli\_control\_mode\_enabled

 [bool](classsimulation__framework_1_1core_1_1Topic.xhtml) simulation\_framework::core::SimulationParameters::cli\_control\_mode\_enabled

A boolean indicating whether CLI control mode is enabled.

Definition at line [74](simulation__parameters_8h_source.xhtml#l00074) of file [simulation\_parameters.h](simulation__parameters_8h_source.xhtml).





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

 std::string simulation\_framework::core::SimulationParameters::id

A string indicating a unique ID for the simulation.

Definition at line [43](simulation__parameters_8h_source.xhtml#l00043) of file [simulation\_parameters.h](simulation__parameters_8h_source.xhtml).





<a id="ad709bca5eef2d162f97b3c7f07df900b" name="ad709bca5eef2d162f97b3c7f07df900b"></a>## [◆ ](#ad709bca5eef2d162f97b3c7f07df900b)input\_files

 std::vector&lt;File&gt; simulation\_framework::core::SimulationParameters::input\_files

A vector of File which simulation uses as input.

Definition at line [64](simulation__parameters_8h_source.xhtml#l00064) of file [simulation\_parameters.h](simulation__parameters_8h_source.xhtml).





<a id="a394b1d58a15a471682013c63f4e37d13" name="a394b1d58a15a471682013c63f4e37d13"></a>## [◆ ](#a394b1d58a15a471682013c63f4e37d13)log\_level

 std::string simulation\_framework::core::SimulationParameters::log\_level

A string indicating the logging level for the simulation.

Definition at line [38](simulation__parameters_8h_source.xhtml#l00038) of file [simulation\_parameters.h](simulation__parameters_8h_source.xhtml).





<a id="a3dc188eb45de6e1481b6ce35ce773588" name="a3dc188eb45de6e1481b6ce35ce773588"></a>## [◆ ](#a3dc188eb45de6e1481b6ce35ce773588)output\_directory

 std::string simulation\_framework::core::SimulationParameters::output\_directory

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

Definition at line [59](simulation__parameters_8h_source.xhtml#l00059) of file [simulation\_parameters.h](simulation__parameters_8h_source.xhtml).





<a id="a234596a492675e46f8c4c0900768093d" name="a234596a492675e46f8c4c0900768093d"></a>## [◆ ](#a234596a492675e46f8c4c0900768093d)scheduler\_event\_timeout

 std::chrono::milliseconds simulation\_framework::core::SimulationParameters::scheduler\_event\_timeout

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

Definition at line [79](simulation__parameters_8h_source.xhtml#l00079) of file [simulation\_parameters.h](simulation__parameters_8h_source.xhtml).





<a id="ad04340b459fca0559a426a198593af73" name="ad04340b459fca0559a426a198593af73"></a>## [◆ ](#ad04340b459fca0559a426a198593af73)scheduling\_config

 std::string simulation\_framework::core::SimulationParameters::scheduling\_config

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

Definition at line [54](simulation__parameters_8h_source.xhtml#l00054) of file [simulation\_parameters.h](simulation__parameters_8h_source.xhtml).





<a id="a2714b6d1f312742f94dc3222ac760fa9" name="a2714b6d1f312742f94dc3222ac760fa9"></a>## [◆ ](#a2714b6d1f312742f94dc3222ac760fa9)simulation\_config

 std::string simulation\_framework::core::SimulationParameters::simulation\_config

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

Definition at line [49](simulation__parameters_8h_source.xhtml#l00049) of file [simulation\_parameters.h](simulation__parameters_8h_source.xhtml).





<a id="aca58e1bd9cc396ed5b520495c61f818a" name="aca58e1bd9cc396ed5b520495c61f818a"></a>## [◆ ](#aca58e1bd9cc396ed5b520495c61f818a)timescale\_factor

 [float](classsimulation__framework_1_1core_1_1Topic.xhtml) simulation\_framework::core::SimulationParameters::timescale\_factor

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

Definition at line [84](simulation__parameters_8h_source.xhtml#l00084) of file [simulation\_parameters.h](simulation__parameters_8h_source.xhtml).





<a id="a394360d7e19a61151974fa528f4f1a2a" name="a394360d7e19a61151974fa528f4f1a2a"></a>## [◆ ](#a394360d7e19a61151974fa528f4f1a2a)version

 std::string simulation\_framework::core::SimulationParameters::version

version A string representing the version of the simulation.

Definition at line [33](simulation__parameters_8h_source.xhtml#l00033) of file [simulation\_parameters.h](simulation__parameters_8h_source.xhtml).





---

The documentation for this struct was generated from the following file:- [simulation\_parameters.h](simulation__parameters_8h_source.xhtml)