Checks for the completion status of a simulation. More...

#include <simulation_completion_checker.h>

Inheritance diagram for simulation_framework::autonomy::SimulationCompletionChecker:

Collaboration diagram for simulation_framework::autonomy::SimulationCompletionChecker:

Public Member Functions
	SimulationCompletionChecker (std::shared_ptr< core::time::IClock > clock_ptr)
	Constructs a `SimulationCompletionChecker` instance. More...

bool	IsSimulationFinished () const
	Checks if the simulation has completed. More...

std::chrono::milliseconds	GetSimulationDuration () const
	Retrieves the total duration of the simulation. More...

Public Member Functions inherited from simulation_framework::core::time::ISimulationCompletionChecker
virtual	~ISimulationCompletionChecker ()=default
	Virtual destructor for proper cleanup of derived classes.

Detailed Description

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

Constructor & Destructor Documentation

◆ 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.

Member Function Documentation

◆ 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.

Returns: The total simulation duration in milliseconds.

Implements simulation_framework::core::time::ISimulationCompletionChecker.

◆ 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.

The documentation for this class was generated from the following file:

simulation_completion_checker.h

AVxcelerate Simulation Framework 2025 R1

simulation_framework::autonomy::SimulationCompletionChecker Class Reference

Public Member Functions