Namespace simulation_framework::autonomy::util

Definition: autonomy/simulation/sim_instance/simulation_input_utils.h (line 26)

Functions

Function GetCustomizedParameterByName

std::optional< std::string > simulation_framework::autonomy::util::GetCustomizedParameterByName(const std::string &name, const core::SimulationParameters &core_parameters)

Retrieves the file path for a specified input file.

Searches for the file path corresponding to the given input file name within the provided simulation parameters.

This function is designed to locate and return file paths dynamically based on the configuration specified in the simulation parameters.

Parameters:

• name: The name of the input file to retrieve.
• core_parameters: The simulation parameters containing the file mappings or paths.

Returns:

The full path of the input file as a string, if exists.

Exceptions:

• std::runtime_error: if the file path for the given name cannot be found.

Parameters:

• const std::string & name
• const core::SimulationParameters & core_parameters

Return type: std::optional< std::string >

Function GetInputOpenScenarioFilePath

std::string simulation_framework::autonomy::util::GetInputOpenScenarioFilePath(const core::SimulationParameters &core_parameters)

Retrieves the file path for the OpenScenario input file.

Fetches the path of the OpenScenario file defined in the simulation parameters. This file typically contains scenario configurations in OpenScenario format, used to define simulation scenarios.

Parameters:

• core_parameters: The simulation parameters containing the OpenScenario file path.

Returns:

The full path of the OpenScenario file as a string.

Exceptions:

• std::runtime_error: if the file path cannot be determined.

Parameters:

• const core::SimulationParameters & core_parameters

Return type: std::string

Function GetGtGenUserSettingsFilePath

std::string simulation_framework::autonomy::util::GetGtGenUserSettingsFilePath(const core::SimulationParameters &core_parameters)

Retrieves the file path for the GT-Gen user settings file.

Fetches the path of the user settings file specific to the GT-Gen simulation environment. This file contains configurations or preferences for the user.

Parameters:

• core_parameters: The simulation parameters containing the user settings file path.

Returns:

The full path of the GT-Gen user settings file as a string.

Exceptions:

• std::runtime_error: if the file path cannot be determined.

Parameters:

• const core::SimulationParameters & core_parameters

Return type: std::string

Function GetDriverInputFilePath

std::string simulation_framework::autonomy::util::GetDriverInputFilePath(const core::SimulationParameters &core_parameters)

Retrieves the file path for the driver input file.

Fetches the path of the input file containing driver-specific configurations or input commands for the simulation.

Parameters:

• core_parameters: The simulation parameters containing the driver input file path.

Returns:

The full path of the driver input file as a string.

Exceptions:

• std::runtime_error: if the file path cannot be determined.

Parameters:

• const core::SimulationParameters & core_parameters

Return type: std::string