## On this page

  

 

 # simulation\_framework::autonomy::SimulationCompletionChecker Class Reference

 Last update: 16.07.2025 

Checks for the completion status of a simulation. [More...](classsimulation__framework_1_1autonomy_1_1SimulationCompletionChecker.xhtml#details)

`#include <<a class="el" href="simulation__completion__checker_8h_source.xhtml">simulation_completion_checker.h</a>>`

Inheritance diagram for simulation_framework::autonomy::SimulationCompletionChecker:

![Inheritance graph](/sites/default/files/migrate-content/avxcelerate_simulation_framework_2025_r1_num1/classsimulation__framework_1_1autonomy_1_1SimulationCompletionChecker__inherit__graph.png)

\[[legend](graph_legend.xhtml)\]

Collaboration diagram for simulation_framework::autonomy::SimulationCompletionChecker:

![Collaboration graph](/sites/default/files/migrate-content/avxcelerate_simulation_framework_2025_r1_num1/classsimulation__framework_1_1autonomy_1_1SimulationCompletionChecker__coll__graph.png)

\[[legend](graph_legend.xhtml)\]

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

 [SimulationCompletionChecker](classsimulation__framework_1_1autonomy_1_1SimulationCompletionChecker.xhtml#a85bd966e1832c48fc6c12667dc5f5e78) (std::shared\_ptr&lt; [core::time::IClock](classsimulation__framework_1_1core_1_1time_1_1IClock.xhtml) &gt; clock\_ptr) Constructs a `<a class="el" href="classsimulation__framework_1_1autonomy_1_1SimulationCompletionChecker.xhtml" title="Checks for the completion status of a simulation.">SimulationCompletionChecker</a>` instance. [More...](classsimulation__framework_1_1autonomy_1_1SimulationCompletionChecker.xhtml#a85bd966e1832c48fc6c12667dc5f5e78)  
 bool [IsSimulationFinished](classsimulation__framework_1_1autonomy_1_1SimulationCompletionChecker.xhtml#a0645db7a9eac221d6bb082aa9e17ee40) () const Checks if the simulation has completed. [More...](classsimulation__framework_1_1autonomy_1_1SimulationCompletionChecker.xhtml#a0645db7a9eac221d6bb082aa9e17ee40)  
 std::chrono::milliseconds [GetSimulationDuration](classsimulation__framework_1_1autonomy_1_1SimulationCompletionChecker.xhtml#a674728b07de32646b3cb51aa3e24f61f) () const Retrieves the total duration of the simulation. [More...](classsimulation__framework_1_1autonomy_1_1SimulationCompletionChecker.xhtml#a674728b07de32646b3cb51aa3e24f61f)  
 ![-](/sites/default/files/migrate-content/avxcelerate_simulation_framework_2025_r1_num1/closed.png) Public Member Functions inherited from [simulation\_framework::core::time::ISimulationCompletionChecker](classsimulation__framework_1_1core_1_1time_1_1ISimulationCompletionChecker.xhtml)<a id="ac4b8c8898ef46c452ef5631a5c4c62ee"></a>virtual [~ISimulationCompletionChecker](classsimulation__framework_1_1core_1_1time_1_1ISimulationCompletionChecker.xhtml#ac4b8c8898ef46c452ef5631a5c4c62ee) ()=default Virtual destructor for proper cleanup of derived classes.   
 <a id="details" name="details"></a>## Detailed Description

Checks for the completion status of a simulation.

The `<a class="el" href="classsimulation__framework_1_1autonomy_1_1SimulationCompletionChecker.xhtml" title="Checks for the completion status of a simulation.">SimulationCompletionChecker</a>` class implements the `ISimulationCompletionChecker` interface to determine whether a simulation has finished. It uses a clock interface only as duration depends on actual run and shutdown triggers.

The class leverages the clock interface for time-based operations.

See alsoISimulationCompletionChecker, [core::time::IClock](classsimulation__framework_1_1core_1_1time_1_1IClock.xhtml "Interface for managing and manipulating simulation time.")

## Constructor &amp; Destructor Documentation

<a id="a85bd966e1832c48fc6c12667dc5f5e78"></a>## [◆ ](#a85bd966e1832c48fc6c12667dc5f5e78)SimulationCompletionChecker()

 simulation\_framework::autonomy::SimulationCompletionChecker::SimulationCompletionChecker  ( std::shared\_ptr&lt; [core::time::IClock](classsimulation__framework_1_1core_1_1time_1_1IClock.xhtml) &gt;  *clock\_ptr*) 

Constructs a `<a class="el" href="classsimulation__framework_1_1autonomy_1_1SimulationCompletionChecker.xhtml" title="Checks for the completion status of a simulation.">SimulationCompletionChecker</a>` instance.

Initializes the checker with a clock interface.

Parameters clock\_ptrA shared pointer to the clock interface for time management during the simulation. 



## Member Function Documentation

<a id="a674728b07de32646b3cb51aa3e24f61f"></a>## [◆ ](#a674728b07de32646b3cb51aa3e24f61f)GetSimulationDuration()

 std::chrono::milliseconds simulation\_framework::autonomy::SimulationCompletionChecker::GetSimulationDuration  ( )  const  virtual 

Retrieves the total duration of the simulation.

Returns the default value of -1 as scenario duration depends on the actual run.

ReturnsThe total simulation duration in milliseconds. Implements [simulation\_framework::core::time::ISimulationCompletionChecker](classsimulation__framework_1_1core_1_1time_1_1ISimulationCompletionChecker.xhtml#a7c36f8d7309df7770a08208f5157a3a1).





<a id="a0645db7a9eac221d6bb082aa9e17ee40"></a>## [◆ ](#a0645db7a9eac221d6bb082aa9e17ee40)IsSimulationFinished()

 bool simulation\_framework::autonomy::SimulationCompletionChecker::IsSimulationFinished  ( )  const  virtual 

Checks if the simulation has completed.

Returns`false` always for interface completion purpose, actual completion depends on the run and shutdown triggers. Implements [simulation\_framework::core::time::ISimulationCompletionChecker](classsimulation__framework_1_1core_1_1time_1_1ISimulationCompletionChecker.xhtml#a3c2a846e58738327837d794ed4ce6136).





---

The documentation for this class was generated from the following file:- [simulation\_completion\_checker.h](simulation__completion__checker_8h_source.xhtml)