Skip to main content

AVxcelerate Simulation Framework 2025 R2

simulation_framework::core::SimulationParameters Struct Reference

Last update: 16.07.2025

The SimulationParameters struct encapsulates parameters related to simfwk-core configuration. More...

#include <simulation_parameters.h>

Public Attributes

std::string version
 version A string representing the version of the simulation.
 
std::string log_level
 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.
 
std::vector< File > input_files
 A vector of File which simulation uses as input.
 
std::string cli_control_grpc_address
 A string specifying the gRPC address for CLI (Command Line Interface) control.
 
bool cli_control_mode_enabled
 A boolean indicating whether CLI control mode is enabled.
 
std::chrono::milliseconds scheduler_event_timeout
 A duration representing the timeout for scheduler events, expressed in milliseconds.
 
float timescale_factor
 A floating-point value representing the timescale factor for simulation time.
 

Detailed Description

The SimulationParameters struct encapsulates parameters related to simfwk-core configuration.

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

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

Definition at line 69 of file simulation_parameters.h.

◆ cli_control_mode_enabled

bool simulation_framework::core::SimulationParameters::cli_control_mode_enabled

A boolean indicating whether CLI control mode is enabled.

Definition at line 74 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 43 of file simulation_parameters.h.

◆ input_files

std::vector<File> simulation_framework::core::SimulationParameters::input_files

A vector of File which simulation uses as input.

Definition at line 64 of file simulation_parameters.h.

◆ log_level

std::string simulation_framework::core::SimulationParameters::log_level

A string indicating the logging level for the simulation.

Definition at line 38 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 59 of file simulation_parameters.h.

◆ 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 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 54 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 49 of file simulation_parameters.h.

◆ timescale_factor

float simulation_framework::core::SimulationParameters::timescale_factor

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

Definition at line 84 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 33 of file simulation_parameters.h.


The documentation for this struct was generated from the following file:

Connect with Ansys