Command-line argument parser for simulation framework. More...

#include <cli_parser.h>

Public Member Functions
bool	Parse (int argc, const char **argv)
	Takes the command-line arguments and parses them.

std::string	GetParserMessage () const
	Returns information provided by the parser (e.g., errors or help), if applicable.

const SimulationParameters &	GetSimulationParameters () const
	Returns the simulation framework core parameters.

std::string	GetSimulationConfig () const
	Returns the simulation configuration for the application level.

Detailed Description

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

Definition at line 25 of file cli_parser.h.

Member Function Documentation

◆ 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.

◆ GetSimulationConfig()

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

Returns the simulation configuration for the application level.

Returns: A string containing the simulation configuration.

◆ GetSimulationParameters()

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

Returns the simulation framework core parameters.

Returns: A constant reference to SimulationParameters.

◆ 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.

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

cli_parser.h

AVxcelerate Simulation Framework 2025 R2 SP02

simulation_framework::core::CliParser Class Reference

Public Member Functions