exdsdevs 1.1.0

A Rust library for for developing discrete-event models based on DEVS formalism.
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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

// Copyright 2023 Developers of the exdsdevs project.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms

#![allow(unused_variables)]
use std::fmt::Debug;

use dyn_clone::DynClone;

use crate::{
    containers::{Bag, Mail, SimResult},
    sim_model::SimModel,
    time::Time,
};

impl Debug for Box<dyn Observer> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        Debug::fmt("OBSERVER", f)
    }
}

/// Simulation observation system

/// Trait for simulation event observation
/// # Usage Example
/// ```
/// #[derive(Clone)]
/// struct StatsCollector {
///     event_count: u64,
/// }
///
/// impl Observer for StatsCollector {
///     fn after_internal_transition(&mut self) {
///         self.event_count += 1;
///     }
/// }
/// ```
pub trait Observer: DynClone + Send {
    fn init(&mut self, model: &SimModel, iteration: u64) {}
    /// Called after model initialization
    fn on_init(&mut self, model: &SimModel, init_time: Time, t_next: Time) {}
    fn on_outputs(&mut self, model: &SimModel, sim_time: Time, bag: &Bag) {}
    /// Called before internal transition
    fn before_internal_transition(&mut self, model: &SimModel, sim_time: Time) {}
    /// Called after internal transition
    fn after_internal_transition(&mut self, model: &SimModel, sim_time: Time, t_next: Time) {}
    fn before_external_transition(
        &mut self,
        model: &SimModel,
        sim_time: Time,
        x_bag: &Bag,
        elapsed: Time,
    ) {
    }
    fn after_external_transition(&mut self, model: &SimModel, sim_time: Time, t_next: Time) {}
    fn before_external_mail_transition(
        &mut self,
        model: &SimModel,
        sim_time: Time,
        mail: &Mail,
        elapsed: Time,
    ) {
    }
    fn after_external_mail_transition(&mut self, model: &SimModel, sim_time: Time, t_next: Time) {}
    fn before_confluent_transition(&mut self, model: &SimModel, sim_time: Time, x_bag: &Bag) {}
    fn after_confluent_transition(&mut self, model: &SimModel, sim_time: Time, t_next: Time) {}
    fn after_submodels_transition(&mut self, model: &SimModel, sim_time: Time, t_next: Time) {}
    fn finish(&mut self, model: &SimModel, sim_time: Time) -> Option<SimResult> {
        None
    }
}

impl Clone for Box<dyn Observer> {
    fn clone(&self) -> Self {
        dyn_clone::clone_box(&**self)
    }
}