simulation_framework::core::SimulationParameters Struct Reference
Last update: 19.09.2025The SimulationParameters struct encapsulates parameters related to simfwk-core configuration. More...
#include <simulation_parameters.h>
Public Types | |
| using | 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. | |
Public Attributes | |
| std::string | version = "" |
| version A string representing the version of the simulation. | |
| std::string | log_level = "Debug" |
| A string indicating the logging level for the simulation. | |
| std::string | id = "" |
| A string indicating a unique ID for the simulation. | |
| std::string | simulation_config = "" |
| A string indicating the path to the simulation configuration file for your built simulation application. | |
| std::string | scheduling_config = "" |
| A string containing the scheduling configuration file path for the simulation. | |
| std::string | output_directory = "./" |
| A string indicating the path where simulation shall dump out files. | |
| CustomizedParameters | customized_parameters = {} |
| A map of customized parameters which simulation could use as input. | |
| std::string | cli_control_grpc_address = "localhost:50051" |
| A string specifying the gRPC address for CLI (Command Line Interface) control. The format should be "host:port". | |
| bool | cli_control_mode_enabled = false |
| A boolean indicating whether CLI control mode is enabled. | |
| std::chrono::milliseconds | scheduler_event_timeout = std::chrono::milliseconds(60000) |
| A duration representing the timeout for scheduler events, expressed in milliseconds. | |
| float | timescale_factor = -1.0f |
| A floating-point value representing the timescale factor for simulation time. | |
| bool | debugger_enabled = false |
| A boolean indicating whether the Debugger is enabled. | |
Static Public Attributes | |
| static constexpr size_t | kMaxCustomizedParamNameLength = 64 |
| Maximum allowed lengths for customized parameter names and values, to prevent unintended behavior. | |
| static constexpr size_t | kMaxCustomizedParamValueLength = 1024 |
Detailed Description
The SimulationParameters struct encapsulates parameters related to simfwk-core configuration.
Definition at line 22 of file simulation_parameters.h.
Member Typedef Documentation
◆ CustomizedParameters
| 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.
Definition at line 28 of file simulation_parameters.h.
Member Data Documentation
◆ cli_control_grpc_address
| 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".
Definition at line 75 of file simulation_parameters.h.
◆ cli_control_mode_enabled
A boolean indicating whether CLI control mode is enabled.
Definition at line 80 of file simulation_parameters.h.
◆ customized_parameters
| CustomizedParameters simulation_framework::core::SimulationParameters::customized_parameters = {} |
A map of customized parameters which simulation could use as input.
Definition at line 69 of file simulation_parameters.h.
◆ debugger_enabled
A boolean indicating whether the Debugger is enabled.
Definition at line 95 of file simulation_parameters.h.
◆ id
| std::string simulation_framework::core::SimulationParameters::id = "" |
A string indicating a unique ID for the simulation.
Definition at line 48 of file simulation_parameters.h.
◆ kMaxCustomizedParamNameLength
|
staticconstexpr |
Maximum allowed lengths for customized parameter names and values, to prevent unintended behavior.
Definition at line 33 of file simulation_parameters.h.
◆ kMaxCustomizedParamValueLength
|
staticconstexpr |
Definition at line 34 of file simulation_parameters.h.
◆ log_level
| std::string simulation_framework::core::SimulationParameters::log_level = "Debug" |
A string indicating the logging level for the simulation.
Definition at line 43 of file simulation_parameters.h.
◆ output_directory
| std::string simulation_framework::core::SimulationParameters::output_directory = "./" |
A string indicating the path where simulation shall dump out files.
Definition at line 64 of file simulation_parameters.h.
◆ scheduler_event_timeout
| 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.
Definition at line 85 of file simulation_parameters.h.
◆ scheduling_config
| std::string simulation_framework::core::SimulationParameters::scheduling_config = "" |
A string containing the scheduling configuration file path for the simulation.
Definition at line 59 of file simulation_parameters.h.
◆ 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 54 of file simulation_parameters.h.
◆ timescale_factor
| float simulation_framework::core::SimulationParameters::timescale_factor = -1.0f |
A floating-point value representing the timescale factor for simulation time.
Definition at line 90 of file simulation_parameters.h.
◆ version
| std::string simulation_framework::core::SimulationParameters::version = "" |
version A string representing the version of the simulation.
Definition at line 38 of file simulation_parameters.h.
The documentation for this struct was generated from the following file:
