## On this page

  

 

 # Class simulation\_framework::core::Cli

 Last update: 22.04.2026 

![](https://img.shields.io/badge/language-C%2B%2B-blue "C++")![](https://img.shields.io/badge/-public-brightgreen "public")

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

Handles the decision to start the simulation framework.

The `<a href="classsimulation__framework_1_1core_1_1Cli.md#classsimulation__framework_1_1core_1_1Cli">Cli</a>` class is responsible for determining if the simulation framework runner (`<a href="classsimulation__framework_1_1core_1_1ISimRunner.md#classsimulation__framework_1_1core_1_1ISimRunner">ISimRunner</a>`) 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](classsimulation__framework_1_1core_1_1ISimRunner.md#classsimulation__framework_1_1core_1_1ISimRunner), [ISimfwkCliServer](classsimulation__framework_1_1core_1_1ISimfwkCliServer.md#classsimulation__framework_1_1core_1_1ISimfwkCliServer)

## Members

- [Cli](classsimulation__framework_1_1core_1_1Cli.md#classsimulation__framework_1_1core_1_1Cli_1a807aa80e06431cbd27fe12c4856b668f)
- [Execute](classsimulation__framework_1_1core_1_1Cli.md#classsimulation__framework_1_1core_1_1Cli_1a39259f9147a9151d89d372d4fa9f278f)

## Public functions

<a id="classsimulation__framework_1_1core_1_1Cli_1a807aa80e06431cbd27fe12c4856b668f"></a>

### Function Cli

![](https://img.shields.io/badge/-public-brightgreen "public")

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

```

Constructs the `<a href="classsimulation__framework_1_1core_1_1Cli.md#classsimulation__framework_1_1core_1_1Cli">Cli</a>` 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&lt; [ISimRunner](classsimulation__framework_1_1core_1_1ISimRunner.md#classsimulation__framework_1_1core_1_1ISimRunner) &gt; **sim\_runner**
- std::unique\_ptr&lt; [ISimfwkCliServer](classsimulation__framework_1_1core_1_1ISimfwkCliServer.md#classsimulation__framework_1_1core_1_1ISimfwkCliServer) &gt; **simfwk\_cli\_server** = [nullptr](classsimulation__framework_1_1core_1_1Topic.md#classsimulation__framework_1_1core_1_1Topic)

**Return type**:

<a id="classsimulation__framework_1_1core_1_1Cli_1a39259f9147a9151d89d372d4fa9f278f"></a>

### Function Execute

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
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](classsimulation__framework_1_1core_1_1Topic.md#classsimulation__framework_1_1core_1_1Topic)