Skip to main content

AVxcelerate Simulation Framework 2025 R2 SP02

i_sim_runner

Last update: 19.09.2025
1
3
4#pragma once
5
6#include <string>
7
13{
14namespace core
15{
16
19{
22
24 std::string error_msg;
25};
26
28enum class SimState
29{
30 kInitialized,
31 kRunning,
32 kPaused,
33 kFinished,
34 kTerminated,
35 kError
36};
37
42{
43 public:
45 virtual ~ISimRunner() = default;
46
49 virtual StateFeedback Run() = 0;
50
53 virtual StateFeedback Pause() = 0;
54
57 virtual StateFeedback Resume() = 0;
58
62 virtual StateFeedback StepN(int n) = 0;
63
66 virtual StateFeedback Stop() = 0;
67
70 virtual StateFeedback Terminate() = 0;
71
74 virtual SimState GetSimulationState() const = 0;
75
78 virtual uint64_t GetExecutedStepCount() const = 0;
79
81 virtual void RunOverSimulation() = 0;
82};
83
84} // namespace core
85} // namespace simulation_framework
Interface for controlling and managing simulation execution.
virtual StateFeedback StepN(int n)=0
Advances the simulation by a specified number of steps.
virtual ~ISimRunner()=default
Virtual destructor for proper cleanup of derived classes.
virtual StateFeedback Resume()=0
Resumes the simulation if it is paused.
virtual StateFeedback Stop()=0
Stops the simulation.
virtual SimState GetSimulationState() const =0
Retrieves the current state of the simulation.
virtual StateFeedback Pause()=0
Pauses the simulation.
virtual StateFeedback Terminate()=0
Terminates the simulation completely.
virtual StateFeedback Run()=0
Starts 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.
This is the concrete Topic class that can be used for creation of a communication channel with given ...
Definition topic.h:38
The namespace for all core functionalities under namespace simulation_framework.
The top namespace for simulation framework.
Represents feedback for the execution status of a control command.
bool execute_status
Indicates whether the control command was executed successfully.
std::string error_msg
Error message describing the issue if execution failed.

Connect with Ansys