Class simulation_framework::core::ISimRunner
Last update: 22.04.2026
Definition: core/service/sim_runner/i_sim_runner.h (line 43)
Interface for controlling and managing simulation execution.
The ISimRunner interface provides a set of external control APIs for managing the lifecycle and execution of a simulation.
Inherited by:
Members
- GetExecutedStepCount
- GetSimulationState
- Pause
- Resume
- Run
- RunOverSimulation
- StepN
- Stop
- Terminate
- ~ISimRunner
Public functions
Function ~ISimRunner
virtual simulation_framework::core::ISimRunner::~ISimRunner()=default
Virtual destructor for proper cleanup of derived classes.
Return type:
Function Run
virtual StateFeedback simulation_framework::core::ISimRunner::Run()=0
Starts the simulation.
Returns:
A StateFeedback object indicating the result of the operation.
Return type: StateFeedback
Reimplemented by:
Function Pause
virtual StateFeedback simulation_framework::core::ISimRunner::Pause()=0
Pauses the simulation.
Returns:
A StateFeedback object indicating the result of the operation.
Return type: StateFeedback
Reimplemented by:
Function Resume
virtual StateFeedback simulation_framework::core::ISimRunner::Resume()=0
Resumes the simulation if it is paused.
Returns:
A StateFeedback object indicating the result of the operation.
Return type: StateFeedback
Reimplemented by:
Function StepN
virtual StateFeedback simulation_framework::core::ISimRunner::StepN(int n)=0
Advances the simulation by a specified number of steps.
Parameters:
- n: The number of simulation steps to execute.
Returns:
A StateFeedback object indicating the result of the operation.
Parameters:
- int n
Return type: StateFeedback
Reimplemented by:
Function Stop
virtual StateFeedback simulation_framework::core::ISimRunner::Stop()=0
Stops the simulation.
Returns:
A StateFeedback object indicating the result of the operation.
Return type: StateFeedback
Reimplemented by:
Function Terminate
virtual StateFeedback simulation_framework::core::ISimRunner::Terminate()=0
Terminates the simulation completely.
Returns:
A StateFeedback object indicating the result of the operation.
Return type: StateFeedback
Reimplemented by:
Function GetSimulationState
virtual SimState simulation_framework::core::ISimRunner::GetSimulationState() const =0
Retrieves the current state of the simulation.
Returns:
The current simulation state as a SimState enum value.
Return type: SimState
Reimplemented by:
Function GetExecutedStepCount
virtual uint64_t simulation_framework::core::ISimRunner::GetExecutedStepCount() const =0
Retrieves the number of steps executed so far.
Returns:
The total number of steps executed as a 64-bit unsigned integer.
Return type: uint64_t
Reimplemented by:
Function RunOverSimulation
virtual void simulation_framework::core::ISimRunner::RunOverSimulation()=0
Runs any remaining parts of the simulation to completion.
Return type: void
Reimplemented by:
