## On this page

  

 

 # Structure simulation\_framework::core::SimulationParameters

 Last update: 22.04.2026 

![](https://img.shields.io/badge/language-C%2B%2B-blue "C++")![](https://img.shields.io/badge/-public-brightgreen "public")

**Definition**: `core/service/parameter/simulation_parameters.h` (line 24)

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

## Members

- [breakpoints\_file\_path](structsimulation__framework_1_1core_1_1SimulationParameters.md#structsimulation__framework_1_1core_1_1SimulationParameters_1a8d443b6771dafc576ce1138f399e2760)
- [cli\_control\_grpc\_address](structsimulation__framework_1_1core_1_1SimulationParameters.md#structsimulation__framework_1_1core_1_1SimulationParameters_1af8a90b2bef8680b69a15813e60c93404)
- [cli\_control\_mode\_enabled](structsimulation__framework_1_1core_1_1SimulationParameters.md#structsimulation__framework_1_1core_1_1SimulationParameters_1a0b5db8592c55e9a1c4eb17eae6d23283)
- [customized\_parameters](structsimulation__framework_1_1core_1_1SimulationParameters.md#structsimulation__framework_1_1core_1_1SimulationParameters_1a1aabfd1ab24a9fec7079fe8bc391060b)
- [CustomizedParameters](structsimulation__framework_1_1core_1_1SimulationParameters.md#structsimulation__framework_1_1core_1_1SimulationParameters_1a25a000c4c4dfefb04ff71a796e06c787)
- [debugger\_enabled](structsimulation__framework_1_1core_1_1SimulationParameters.md#structsimulation__framework_1_1core_1_1SimulationParameters_1a045453a8cf2bac1ca819d5c49e5c9863)
- [id](structsimulation__framework_1_1core_1_1SimulationParameters.md#structsimulation__framework_1_1core_1_1SimulationParameters_1a1d05a88de7c8c3ff63adf06a52f53c7d)
- [kMaxCustomizedParamNameLength](structsimulation__framework_1_1core_1_1SimulationParameters.md#structsimulation__framework_1_1core_1_1SimulationParameters_1af9f3c73a22e76a7236e6f3300048a8f1)
- [kMaxCustomizedParamValueLength](structsimulation__framework_1_1core_1_1SimulationParameters.md#structsimulation__framework_1_1core_1_1SimulationParameters_1a95b40e23aafac5285a11f2bf2dfeb84a)
- [log\_level](structsimulation__framework_1_1core_1_1SimulationParameters.md#structsimulation__framework_1_1core_1_1SimulationParameters_1a394b1d58a15a471682013c63f4e37d13)
- [output\_directory](structsimulation__framework_1_1core_1_1SimulationParameters.md#structsimulation__framework_1_1core_1_1SimulationParameters_1a3dc188eb45de6e1481b6ce35ce773588)
- [scheduler\_event\_timeout](structsimulation__framework_1_1core_1_1SimulationParameters.md#structsimulation__framework_1_1core_1_1SimulationParameters_1a234596a492675e46f8c4c0900768093d)
- [scheduling\_config](structsimulation__framework_1_1core_1_1SimulationParameters.md#structsimulation__framework_1_1core_1_1SimulationParameters_1ad04340b459fca0559a426a198593af73)
- [simulation\_config](structsimulation__framework_1_1core_1_1SimulationParameters.md#structsimulation__framework_1_1core_1_1SimulationParameters_1a2714b6d1f312742f94dc3222ac760fa9)
- [timescale\_factor](structsimulation__framework_1_1core_1_1SimulationParameters.md#structsimulation__framework_1_1core_1_1SimulationParameters_1aca58e1bd9cc396ed5b520495c61f818a)
- [version](structsimulation__framework_1_1core_1_1SimulationParameters.md#structsimulation__framework_1_1core_1_1SimulationParameters_1a394360d7e19a61151974fa528f4f1a2a)

## Public types

<a id="structsimulation__framework_1_1core_1_1SimulationParameters_1a25a000c4c4dfefb04ff71a796e06c787"></a>

### Typedef CustomizedParameters

![](https://img.shields.io/badge/-public-brightgreen "public")

**Definition**: `core/service/parameter/simulation_parameters.h` (line 30)

```cpp
using simulation_framework::core::SimulationParameters::CustomizedParameters =  std::unordered_map<std::string, std::string>

```

A definition of customized parameters which simulation could use as input. key is the name of the customized parameter, value is the value of the customized parameter in type of `std::string`.

**Return type**: std::unordered\_map&lt; std::string, std::string &gt;

## Public static attributes

<a id="structsimulation__framework_1_1core_1_1SimulationParameters_1af9f3c73a22e76a7236e6f3300048a8f1"></a>

### Variable kMaxCustomizedParamNameLength

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-static-lightgrey "static")

**Definition**: `core/service/parameter/simulation_parameters.h` (line 35)

```cpp
constexpr size_t simulation_framework::core::SimulationParameters::kMaxCustomizedParamNameLength = 64

```

Maximum allowed lengths for customized parameter names and values, to prevent unintended behavior.

**Type**: [constexpr](classsimulation__framework_1_1core_1_1Topic.md#classsimulation__framework_1_1core_1_1Topic) [size\_t](classsimulation__framework_1_1core_1_1Topic.md#classsimulation__framework_1_1core_1_1Topic)

<a id="structsimulation__framework_1_1core_1_1SimulationParameters_1a95b40e23aafac5285a11f2bf2dfeb84a"></a>

### Variable kMaxCustomizedParamValueLength

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-static-lightgrey "static")

**Definition**: `core/service/parameter/simulation_parameters.h` (line 36)

```cpp
constexpr size_t simulation_framework::core::SimulationParameters::kMaxCustomizedParamValueLength = 1024

```

**Type**: [constexpr](classsimulation__framework_1_1core_1_1Topic.md#classsimulation__framework_1_1core_1_1Topic) [size\_t](classsimulation__framework_1_1core_1_1Topic.md#classsimulation__framework_1_1core_1_1Topic)

## Public attributes

<a id="structsimulation__framework_1_1core_1_1SimulationParameters_1a394360d7e19a61151974fa528f4f1a2a"></a>

### Variable version

![](https://img.shields.io/badge/-public-brightgreen "public")

**Definition**: `core/service/parameter/simulation_parameters.h` (line 40)

```cpp
std::string simulation_framework::core::SimulationParameters::version = ""

```

version A string representing the version of the simulation.

**Type**: std::string

<a id="structsimulation__framework_1_1core_1_1SimulationParameters_1a394b1d58a15a471682013c63f4e37d13"></a>

### Variable log\_level

![](https://img.shields.io/badge/-public-brightgreen "public")

**Definition**: `core/service/parameter/simulation_parameters.h` (line 45)

```cpp
std::string simulation_framework::core::SimulationParameters::log_level = "Debug"

```

A string indicating the logging level for the simulation.

**Type**: std::string

<a id="structsimulation__framework_1_1core_1_1SimulationParameters_1a1d05a88de7c8c3ff63adf06a52f53c7d"></a>

### Variable id

![](https://img.shields.io/badge/-public-brightgreen "public")

**Definition**: `core/service/parameter/simulation_parameters.h` (line 50)

```cpp
std::string simulation_framework::core::SimulationParameters::id = ""

```

A string indicating a unique ID for the simulation.

**Type**: std::string

<a id="structsimulation__framework_1_1core_1_1SimulationParameters_1a2714b6d1f312742f94dc3222ac760fa9"></a>

### Variable simulation\_config

![](https://img.shields.io/badge/-public-brightgreen "public")

**Definition**: `core/service/parameter/simulation_parameters.h` (line 56)

```cpp
std::string simulation_framework::core::SimulationParameters::simulation_config = ""

```

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

**Type**: std::string

<a id="structsimulation__framework_1_1core_1_1SimulationParameters_1ad04340b459fca0559a426a198593af73"></a>

### Variable scheduling\_config

![](https://img.shields.io/badge/-public-brightgreen "public")

**Definition**: `core/service/parameter/simulation_parameters.h` (line 61)

```cpp
std::string simulation_framework::core::SimulationParameters::scheduling_config = ""

```

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

**Type**: std::string

<a id="structsimulation__framework_1_1core_1_1SimulationParameters_1a3dc188eb45de6e1481b6ce35ce773588"></a>

### Variable output\_directory

![](https://img.shields.io/badge/-public-brightgreen "public")

**Definition**: `core/service/parameter/simulation_parameters.h` (line 66)

```cpp
std::string simulation_framework::core::SimulationParameters::output_directory = "./"

```

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

**Type**: std::string

<a id="structsimulation__framework_1_1core_1_1SimulationParameters_1a1aabfd1ab24a9fec7079fe8bc391060b"></a>

### Variable customized\_parameters

![](https://img.shields.io/badge/-public-brightgreen "public")

**Definition**: `core/service/parameter/simulation_parameters.h` (line 71)

```cpp
CustomizedParameters simulation_framework::core::SimulationParameters::customized_parameters = {}

```

A map of customized parameters which simulation could use as input.

**Type**: [CustomizedParameters](structsimulation__framework_1_1core_1_1SimulationParameters.md#structsimulation__framework_1_1core_1_1SimulationParameters_1a25a000c4c4dfefb04ff71a796e06c787)

<a id="structsimulation__framework_1_1core_1_1SimulationParameters_1af8a90b2bef8680b69a15813e60c93404"></a>

### Variable cli\_control\_grpc\_address

![](https://img.shields.io/badge/-public-brightgreen "public")

**Definition**: `core/service/parameter/simulation_parameters.h` (line 77)

```cpp
std::string simulation_framework::core::SimulationParameters::cli_control_grpc_address = "localhost:50051"

```

A string specifying the gRPC address for CLI (Command Line Interface) control. The format should be "host:port".

**Type**: std::string

<a id="structsimulation__framework_1_1core_1_1SimulationParameters_1a0b5db8592c55e9a1c4eb17eae6d23283"></a>

### Variable cli\_control\_mode\_enabled

![](https://img.shields.io/badge/-public-brightgreen "public")

**Definition**: `core/service/parameter/simulation_parameters.h` (line 82)

```cpp
bool simulation_framework::core::SimulationParameters::cli_control_mode_enabled = [false](classsimulation__framework_1_1core_1_1Topic.md#classsimulation__framework_1_1core_1_1Topic)

```

A boolean indicating whether CLI control mode is enabled.

**Type**: [bool](classsimulation__framework_1_1core_1_1Topic.md#classsimulation__framework_1_1core_1_1Topic)

<a id="structsimulation__framework_1_1core_1_1SimulationParameters_1a234596a492675e46f8c4c0900768093d"></a>

### Variable scheduler\_event\_timeout

![](https://img.shields.io/badge/-public-brightgreen "public")

**Definition**: `core/service/parameter/simulation_parameters.h` (line 87)

```cpp
std::chrono::milliseconds simulation_framework::core::SimulationParameters::scheduler_event_timeout = std::chrono::milliseconds(60000)

```

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

**Type**: std::chrono::milliseconds

<a id="structsimulation__framework_1_1core_1_1SimulationParameters_1aca58e1bd9cc396ed5b520495c61f818a"></a>

### Variable timescale\_factor

![](https://img.shields.io/badge/-public-brightgreen "public")

**Definition**: `core/service/parameter/simulation_parameters.h` (line 92)

```cpp
float simulation_framework::core::SimulationParameters::timescale_factor = -1.0f

```

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

**Type**: [float](classsimulation__framework_1_1core_1_1Topic.md#classsimulation__framework_1_1core_1_1Topic)

<a id="structsimulation__framework_1_1core_1_1SimulationParameters_1a045453a8cf2bac1ca819d5c49e5c9863"></a>

### Variable debugger\_enabled

![](https://img.shields.io/badge/-public-brightgreen "public")

**Definition**: `core/service/parameter/simulation_parameters.h` (line 97)

```cpp
bool simulation_framework::core::SimulationParameters::debugger_enabled = [false](classsimulation__framework_1_1core_1_1Topic.md#classsimulation__framework_1_1core_1_1Topic)

```

A boolean indicating whether the Debugger is enabled.

**Type**: [bool](classsimulation__framework_1_1core_1_1Topic.md#classsimulation__framework_1_1core_1_1Topic)

<a id="structsimulation__framework_1_1core_1_1SimulationParameters_1a8d443b6771dafc576ce1138f399e2760"></a>

### Variable breakpoints\_file\_path

![](https://img.shields.io/badge/-public-brightgreen "public")

**Definition**: `core/service/parameter/simulation_parameters.h` (line 102)

```cpp
std::string simulation_framework::core::SimulationParameters::breakpoints_file_path = ""

```

A string containing the path to the breakpoints file for the simulation.

**Type**: std::string