Class simulation_framework::core::CliParser

Definition: core/service/cli/cli_parser.h (line 25)

Command-line argument parser for simulation framework.

The CliParser class provides generic functionality to parse command-line arguments and extract simulation-related parameters, configuration, and customized parameters. It helps in converting command-line input into structured simulation parameters.

See also: SimulationParameters, SimulationParameters::CustomizedParameters

Members

• ConvertCustomizedParameterFromArgs
• GetParserMessage
• GetSimulationConfig
• GetSimulationParameters
• Parse

Public functions

Function Parse

bool simulation_framework::core::CliParser::Parse(int argc, const char **argv)

Takes the command-line arguments and parses them.

Returns false if there is a parse error; otherwise, returns true.

Parameters:

• argc: The number of arguments.
• argv: An array of argument strings.

Returns:

true if parsing is successful; false otherwise.

Parameters:

• int argc
• const char ** argv

Return type: bool

Function GetParserMessage

std::string simulation_framework::core::CliParser::GetParserMessage() const

Returns information provided by the parser (e.g., errors or help), if applicable.

Returns:

A string containing parser information.

Return type: std::string

Function GetSimulationParameters

const SimulationParameters & simulation_framework::core::CliParser::GetSimulationParameters() const

Returns the simulation framework core parameters.

Returns:

A constant reference to SimulationParameters.

Return type: const SimulationParameters &

Function GetSimulationConfig

std::string simulation_framework::core::CliParser::GetSimulationConfig() const

Returns the simulation configuration for the application level.

Returns:

A string containing the simulation configuration.

Return type: std::string