Class simulation_framework::autonomy::SimulationCompletionChecker

Definition: autonomy/simulation/simulation_completion_checker/simulation_completion_checker.h (line 36)

Checks for the completion status of a simulation.

The SimulationCompletionChecker 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 also: ISimulationCompletionChecker, core::time::IClock

Inherits from:

• simulation_framework::core::time::ISimulationCompletionChecker

Members

• GetSimulationDuration
• IsSimulationFinished
• SimulationCompletionChecker
• ~ISimulationCompletionChecker

Public functions

Function SimulationCompletionChecker

simulation_framework::autonomy::SimulationCompletionChecker::SimulationCompletionChecker(std::shared_ptr< core::time::IClock > clock_ptr)

Constructs a SimulationCompletionChecker instance.

Initializes the checker with a clock interface.

Parameters:

• clock_ptr: A shared pointer to the clock interface for time management during the simulation.

Parameters:

• std::shared_ptr< core::time::IClock > clock_ptr

Return type:

Function IsSimulationFinished

bool simulation_framework::autonomy::SimulationCompletionChecker::IsSimulationFinished() const

Checks if the simulation has completed.

Returns:

false always for interface completion purpose, actual completion depends on the run and shutdown triggers.

Return type: bool

Reimplements: IsSimulationFinished

Function GetSimulationDuration

std::chrono::milliseconds simulation_framework::autonomy::SimulationCompletionChecker::GetSimulationDuration() const

Retrieves the total duration of the simulation.

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

Returns:

The total simulation duration in milliseconds.

Return type: std::chrono::milliseconds

Reimplements: GetSimulationDuration