## On this page

  

 

 # simulation\_framework::core::Cli Class Reference

 Last update: 19.09.2025 

Handles the decision to start the simulation framework. [More...](classsimulation__framework_1_1core_1_1Cli.xhtml#details)

`#include <<a class="el" href="cli_8h_source.xhtml">cli.h</a>>`

## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

 [Cli](classsimulation__framework_1_1core_1_1Cli.xhtml#a807aa80e06431cbd27fe12c4856b668f) (std::unique\_ptr&lt; [ISimRunner](classsimulation__framework_1_1core_1_1ISimRunner.xhtml) &gt; [sim\_runner](classsimulation__framework_1_1core_1_1Topic.xhtml), std::unique\_ptr&lt; [ISimfwkCliServer](classsimulation__framework_1_1core_1_1ISimfwkCliServer.xhtml) &gt; [simfwk\_cli\_server](classsimulation__framework_1_1core_1_1Topic.xhtml)=[nullptr](classsimulation__framework_1_1core_1_1Topic.xhtml)) Constructs the `<a class="el" href="classsimulation__framework_1_1core_1_1Cli.xhtml" title="Handles the decision to start the simulation framework.">Cli</a>` object.   
 [bool](classsimulation__framework_1_1core_1_1Topic.xhtml) [Execute](classsimulation__framework_1_1core_1_1Cli.xhtml#a39259f9147a9151d89d372d4fa9f278f) () Executes the appropriate function based on the parsed parameters.   
 <a id="details" name="details"></a>## Detailed Description

Handles the decision to start the simulation framework.

The `<a class="el" href="classsimulation__framework_1_1core_1_1Cli.xhtml" title="Handles the decision to start the simulation framework.">Cli</a>` class is responsible for determining if the simulation framework runner (`<a class="el" href="classsimulation__framework_1_1core_1_1ISimRunner.xhtml" title="Interface for controlling and managing simulation execution.">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.xhtml "Interface for controlling and managing simulation execution."), [ISimfwkCliServer](classsimulation__framework_1_1core_1_1ISimfwkCliServer.xhtml "class ISimfwkCliServer")Definition at line [25](cli_8h_source.xhtml#l00025) of file [cli.h](cli_8h_source.xhtml).



## Constructor &amp; Destructor Documentation

<a id="a807aa80e06431cbd27fe12c4856b668f" name="a807aa80e06431cbd27fe12c4856b668f"></a>## [◆ ](#a807aa80e06431cbd27fe12c4856b668f)Cli()

 simulation\_framework::core::Cli::Cli  ( std::unique\_ptr&lt; [ISimRunner](classsimulation__framework_1_1core_1_1ISimRunner.xhtml) &gt;  *sim\_runner*,    std::unique\_ptr&lt; [ISimfwkCliServer](classsimulation__framework_1_1core_1_1ISimfwkCliServer.xhtml) &gt;  *simfwk\_cli\_server* = `<a class="el" href="classsimulation__framework_1_1core_1_1Topic.xhtml">nullptr</a>`   ) 

Constructs the `<a class="el" href="classsimulation__framework_1_1core_1_1Cli.xhtml" title="Handles the decision to start the simulation framework.">Cli</a>` object.

Parameters sim\_runnerInstance of the simulation runner controlled by the CLI. simfwk\_cli\_serverOptional instance of the CLI server for CLI controller mode. 



## Member Function Documentation

<a id="a39259f9147a9151d89d372d4fa9f278f" name="a39259f9147a9151d89d372d4fa9f278f"></a>## [◆ ](#a39259f9147a9151d89d372d4fa9f278f)Execute()

 [bool](classsimulation__framework_1_1core_1_1Topic.xhtml) 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`. 



---

The documentation for this class was generated from the following file:- [cli.h](cli_8h_source.xhtml)