Class simulation_framework::core::Cli

Definition: core/service/cli/cli.h (line 26)

Handles the decision to start the simulation framework.

The Cli class is responsible for determining if the simulation framework runner (ISimRunner) should be initialized and started based on the simulation parameters derived from command-line arguments. It can also interact with the CLI server if enabled.

See also: ISimRunner, ISimfwkCliServer

Members

• Cli
• Execute

Public functions

Function Cli

simulation_framework::core::Cli::Cli(std::unique_ptr< ISimRunner > sim_runner, std::unique_ptr< ISimfwkCliServer > simfwk_cli_server=nullptr)

Constructs the Cli object.

Parameters:

• sim_runner: Instance of the simulation runner controlled by the CLI.
• simfwk_cli_server: Optional instance of the CLI server for CLI controller mode.

Parameters:

• std::unique_ptr< ISimRunner > sim_runner
• std::unique_ptr< ISimfwkCliServer > simfwk_cli_server = nullptr

Return type:

Function Execute

bool simulation_framework::core::Cli::Execute()

Executes the appropriate function based on the parsed parameters.

This function decides which action to take, such as running the simulation or performing other tasks, based on the parameters provided during initialization.

Returns:

true if execution is successful; otherwise, false.

Return type: bool