Skip to main content

armillae_simulate/
simulation.rs

1use schemars::JsonSchema;
2use serde::{Deserialize, Serialize};
3
4use crate::{
5    AdvanceOutcome, AdvanceRequest, ClockKey, ClockState, ExecuteOutcome, ExecuteRequest,
6    SimulationCapabilities, SimulationError,
7};
8
9#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
10#[serde(rename_all = "snake_case")]
11#[non_exhaustive]
12pub enum SimulationStatus {
13    Active,
14    Stopped,
15    Faulted,
16}
17
18pub trait Simulation: Send {
19    fn status(&self) -> SimulationStatus;
20
21    fn capabilities(&self) -> SimulationCapabilities;
22
23    fn execute(&mut self, request: ExecuteRequest) -> Result<ExecuteOutcome, SimulationError>;
24
25    fn read_clock(&self, key: &ClockKey) -> Result<ClockState, SimulationError>;
26
27    fn insert_clock(&mut self, state: ClockState) -> Result<(), SimulationError>;
28
29    fn remove_clock(&mut self, key: &ClockKey) -> Result<ClockState, SimulationError>;
30
31    fn advance(&mut self, request: AdvanceRequest) -> Result<AdvanceOutcome, SimulationError>;
32
33    fn stop(&mut self) -> Result<(), SimulationError>;
34}