Structure simulation_framework::core::SimulationParameters
Last update: 22.04.2026
Definition: core/service/parameter/simulation_parameters.h (line 24)
The SimulationParameters struct encapsulates parameters related to simfwk-core configuration.
Members
- breakpoints_file_path
- cli_control_grpc_address
- cli_control_mode_enabled
- customized_parameters
- CustomizedParameters
- debugger_enabled
- id
- kMaxCustomizedParamNameLength
- kMaxCustomizedParamValueLength
- log_level
- output_directory
- scheduler_event_timeout
- scheduling_config
- simulation_config
- timescale_factor
- version
Public types
Typedef CustomizedParameters
Definition: core/service/parameter/simulation_parameters.h (line 30)
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< std::string, std::string >
Public static attributes
Variable kMaxCustomizedParamNameLength
Definition: core/service/parameter/simulation_parameters.h (line 35)
constexpr size_t simulation_framework::core::SimulationParameters::kMaxCustomizedParamNameLength = 64
Maximum allowed lengths for customized parameter names and values, to prevent unintended behavior.
Variable kMaxCustomizedParamValueLength
Definition: core/service/parameter/simulation_parameters.h (line 36)
constexpr size_t simulation_framework::core::SimulationParameters::kMaxCustomizedParamValueLength = 1024
Public attributes
Variable version
Definition: core/service/parameter/simulation_parameters.h (line 40)
std::string simulation_framework::core::SimulationParameters::version = ""
version A string representing the version of the simulation.
Type: std::string
Variable log_level
Definition: core/service/parameter/simulation_parameters.h (line 45)
std::string simulation_framework::core::SimulationParameters::log_level = "Debug"
A string indicating the logging level for the simulation.
Type: std::string
Variable id
Definition: core/service/parameter/simulation_parameters.h (line 50)
std::string simulation_framework::core::SimulationParameters::id = ""
A string indicating a unique ID for the simulation.
Type: std::string
Variable simulation_config
Definition: core/service/parameter/simulation_parameters.h (line 56)
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
Variable scheduling_config
Definition: core/service/parameter/simulation_parameters.h (line 61)
std::string simulation_framework::core::SimulationParameters::scheduling_config = ""
A string containing the scheduling configuration file path for the simulation.
Type: std::string
Variable output_directory
Definition: core/service/parameter/simulation_parameters.h (line 66)
std::string simulation_framework::core::SimulationParameters::output_directory = "./"
A string indicating the path where simulation shall dump out files.
Type: std::string
Variable customized_parameters
Definition: core/service/parameter/simulation_parameters.h (line 71)
CustomizedParameters simulation_framework::core::SimulationParameters::customized_parameters = {}
A map of customized parameters which simulation could use as input.
Type: CustomizedParameters
Variable cli_control_grpc_address
Definition: core/service/parameter/simulation_parameters.h (line 77)
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
Variable cli_control_mode_enabled
Definition: core/service/parameter/simulation_parameters.h (line 82)
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
Variable scheduler_event_timeout
Definition: core/service/parameter/simulation_parameters.h (line 87)
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
Variable timescale_factor
Definition: core/service/parameter/simulation_parameters.h (line 92)
float simulation_framework::core::SimulationParameters::timescale_factor = -1.0f
A floating-point value representing the timescale factor for simulation time.
Type: float
Variable debugger_enabled
Definition: core/service/parameter/simulation_parameters.h (line 97)
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
Variable breakpoints_file_path
Definition: core/service/parameter/simulation_parameters.h (line 102)
std::string simulation_framework::core::SimulationParameters::breakpoints_file_path = ""
A string containing the path to the breakpoints file for the simulation.
Type: std::string
