des-sim 0.1.0

Classical Event-Driven Simple Simulator Crate for Discrete Event System.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

//! The `user` module defines the `UserContext` trait, which provides a common interface
//! for models and sources to interact with the simulation environment.
//!
//! This trait allows scheduling events and querying the current simulation time.

use crate::modeling::event::EventPriority;
use crate::modeling::model::Model;
use crate::primitive::time::{Duration, MicroStep, SimTime};

/// Provides context information accessible by models during simulation execution.
///
/// Models use this context to query the current simulation time or to schedule
/// future events.
pub trait UserContext<E, M: Model<E>> {
    /// Returns the current simulation tick (absolute time).
    fn current_tick(&self) -> SimTime;

    /// Returns the current micro-step (the index of the step within the current tick).
    fn current_micro_step(&self) -> MicroStep;

    /// Schedules an event with the specified delay and priority.
    ///
    /// # Arguments
    /// * `delay` - The time elapsed from the current simulation time.
    /// * `priority` - The priority level of the event.
    /// * `event_payload` - The data payload associated with the scheduled event.
    fn schedule_event(&mut self, delay: Duration, priority: EventPriority, event_payload: E);
}