AVxcelerate Simulation Framework 2025 R2 SP02

simulation_framework::core::ISimRunner Class Reference

Last update: 19.09.2025

Interface for controlling and managing simulation execution. More...

#include <i_sim_runner.h>

Inheritance diagram for simulation_framework::core::ISimRunner:
Inheritance graph
[legend]

Public Member Functions

virtual ~ISimRunner ()=default
 Virtual destructor for proper cleanup of derived classes.
 
virtual StateFeedback Run ()=0
 Starts the simulation.
 
virtual StateFeedback Pause ()=0
 Pauses the simulation.
 
virtual StateFeedback Resume ()=0
 Resumes the simulation if it is paused.
 
virtual StateFeedback StepN (int n)=0
 Advances the simulation by a specified number of steps.
 
virtual StateFeedback Stop ()=0
 Stops the simulation.
 
virtual StateFeedback Terminate ()=0
 Terminates the simulation completely.
 
virtual SimState GetSimulationState () const =0
 Retrieves the current state of the simulation.
 
virtual uint64_t GetExecutedStepCount () const =0
 Retrieves the number of steps executed so far.
 
virtual void RunOverSimulation ()=0
 Runs any remaining parts of the simulation to completion.
 

Detailed Description

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.

Definition at line 41 of file i_sim_runner.h.

Member Function Documentation

◆ GetExecutedStepCount()

virtual uint64_t simulation_framework::core::ISimRunner::GetExecutedStepCount ( ) const
pure virtual

Retrieves the number of steps executed so far.

Returns
The total number of steps executed as a 64-bit unsigned integer.

Implemented in simulation_framework::core::SimRunner.

◆ GetSimulationState()

virtual SimState simulation_framework::core::ISimRunner::GetSimulationState ( ) const
pure virtual

Retrieves the current state of the simulation.

Returns
The current simulation state as a SimState enum value.

Implemented in simulation_framework::core::SimRunner.

◆ Pause()

virtual StateFeedback simulation_framework::core::ISimRunner::Pause ( )
pure virtual

Pauses the simulation.

Returns
A StateFeedback object indicating the result of the operation.

Implemented in simulation_framework::core::SimRunner.

◆ Resume()

virtual StateFeedback simulation_framework::core::ISimRunner::Resume ( )
pure virtual

Resumes the simulation if it is paused.

Returns
A StateFeedback object indicating the result of the operation.

Implemented in simulation_framework::core::SimRunner.

◆ Run()

virtual StateFeedback simulation_framework::core::ISimRunner::Run ( )
pure virtual

Starts the simulation.

Returns
A StateFeedback object indicating the result of the operation.

Implemented in simulation_framework::core::SimRunner.

◆ RunOverSimulation()

virtual void simulation_framework::core::ISimRunner::RunOverSimulation ( )
pure virtual

Runs any remaining parts of the simulation to completion.

Implemented in simulation_framework::core::SimRunner.

◆ StepN()

virtual StateFeedback simulation_framework::core::ISimRunner::StepN ( int  n)
pure virtual

Advances the simulation by a specified number of steps.

Parameters
nThe number of simulation steps to execute.
Returns
A StateFeedback object indicating the result of the operation.

Implemented in simulation_framework::core::SimRunner.

◆ Stop()

virtual StateFeedback simulation_framework::core::ISimRunner::Stop ( )
pure virtual

Stops the simulation.

Returns
A StateFeedback object indicating the result of the operation.

Implemented in simulation_framework::core::SimRunner.

◆ Terminate()

virtual StateFeedback simulation_framework::core::ISimRunner::Terminate ( )
pure virtual

Terminates the simulation completely.

Returns
A StateFeedback object indicating the result of the operation.

Implemented in simulation_framework::core::SimRunner.

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

Connect with Ansys