Separate model technical specifications from model reporting mechanisms by expanding/splitting traits

Author: ndebuhr

sim/src/models/batcher.rs

@@ -2,7 +2,7 @@ use std::f64::INFINITY;
 
 use serde::{Deserialize, Serialize};
 
-use super::model_trait::{AsModel, SerializableModel};
+use super::model_trait::{DevsModel, Reportable, ReportableModel, SerializableModel};
 use super::ModelMessage;
 use crate::simulator::Services;
 use crate::utils::errors::SimulationError;
@@ -125,15 +125,7 @@ impl Batcher {
     }
 }
 
-impl AsModel for Batcher {
-    fn status(&self) -> String {
-        match self.state.phase {
-            Phase::Passive => String::from("Passive"),
-            Phase::Batching => String::from("Creating batch"),
-            Phase::Release => String::from("Releasing batch"),
-        }
-    }
-
+impl DevsModel for Batcher {
     fn events_ext(
         &mut self,
         incoming_message: &ModelMessage,
@@ -168,3 +160,15 @@ impl AsModel for Batcher {
         self.state.until_next_event
     }
 }
+
+impl Reportable for Batcher {
+    fn status(&self) -> String {
+        match self.state.phase {
+            Phase::Passive => String::from("Passive"),
+            Phase::Batching => String::from("Creating batch"),
+            Phase::Release => String::from("Releasing batch"),
+        }
+    }
+}
+
+impl ReportableModel for Batcher {}

sim/src/models/exclusive_gateway.rs

@@ -2,7 +2,7 @@ use std::f64::INFINITY;
 
 use serde::{Deserialize, Serialize};
 
-use super::model_trait::{AsModel, SerializableModel};
+use super::model_trait::{DevsModel, Reportable, ReportableModel, SerializableModel};
 use super::ModelMessage;
 use crate::input_modeling::IndexRandomVariable;
 use crate::simulator::Services;
@@ -182,15 +182,7 @@ impl ExclusiveGateway {
     }
 }
 
-impl AsModel for ExclusiveGateway {
-    fn status(&self) -> String {
-        match self.state.phase {
-            Phase::Passive => String::from("Passive"),
-            Phase::Pass => format!["Passing {}", self.state.jobs[0].content],
-            Phase::Respond => String::from("Fetching records"),
-        }
-    }
-
+impl DevsModel for ExclusiveGateway {
     fn events_ext(
         &mut self,
         incoming_message: &ModelMessage,
@@ -228,3 +220,15 @@ impl AsModel for ExclusiveGateway {
         self.state.until_next_event
     }
 }
+
+impl Reportable for ExclusiveGateway {
+    fn status(&self) -> String {
+        match self.state.phase {
+            Phase::Passive => String::from("Passive"),
+            Phase::Pass => format!["Passing {}", self.state.jobs[0].content],
+            Phase::Respond => String::from("Fetching records"),
+        }
+    }
+}
+
+impl ReportableModel for ExclusiveGateway {}

sim/src/models/gate.rs

@@ -2,7 +2,7 @@ use std::f64::INFINITY;
 
 use serde::{Deserialize, Serialize};
 
-use super::model_trait::{AsModel, SerializableModel};
+use super::model_trait::{DevsModel, Reportable, ReportableModel, SerializableModel};
 use super::ModelMessage;
 use crate::simulator::Services;
 use crate::utils::default_records_port_name;
@@ -232,16 +232,7 @@ impl Gate {
     }
 }
 
-impl AsModel for Gate {
-    fn status(&self) -> String {
-        match self.state.phase {
-            Phase::Open => String::from("Open"),
-            Phase::Closed => String::from("Closed"),
-            Phase::Pass => format!["Passing {}", self.state.jobs[0].content],
-            Phase::RespondWhileOpen | Phase::RespondWhileClosed => String::from("Fetching records"),
-        }
-    }
-
+impl DevsModel for Gate {
     fn events_ext(
         &mut self,
         incoming_message: &ModelMessage,
@@ -282,3 +273,16 @@ impl AsModel for Gate {
         self.state.until_next_event
     }
 }
+
+impl Reportable for Gate {
+    fn status(&self) -> String {
+        match self.state.phase {
+            Phase::Open => String::from("Open"),
+            Phase::Closed => String::from("Closed"),
+            Phase::Pass => format!["Passing {}", self.state.jobs[0].content],
+            Phase::RespondWhileOpen | Phase::RespondWhileClosed => String::from("Fetching records"),
+        }
+    }
+}
+
+impl ReportableModel for Gate {}

sim/src/models/generator.rs

@@ -1,6 +1,6 @@
 use serde::{Deserialize, Serialize};
 
-use super::model_trait::{AsModel, SerializableModel};
+use super::model_trait::{DevsModel, Reportable, ReportableModel, SerializableModel};
 use super::ModelMessage;
 use crate::input_modeling::ContinuousRandomVariable;
 use crate::input_modeling::Thinning;
@@ -185,11 +185,7 @@ impl Generator {
     }
 }
 
-impl AsModel for Generator {
-    fn status(&self) -> String {
-        format!["Generating {}s", self.ports_out.job]
-    }
-
+impl DevsModel for Generator {
     fn events_ext(
         &mut self,
         incoming_message: &ModelMessage,
@@ -222,3 +218,11 @@ impl AsModel for Generator {
         self.state.until_next_event
     }
 }
+
+impl Reportable for Generator {
+    fn status(&self) -> String {
+        format!["Generating {}s", self.ports_out.job]
+    }
+}
+
+impl ReportableModel for Generator {}

sim/src/models/load_balancer.rs

@@ -2,7 +2,7 @@ use std::f64::INFINITY;
 
 use serde::{Deserialize, Serialize};
 
-use super::model_trait::{AsModel, SerializableModel};
+use super::model_trait::{DevsModel, Reportable, ReportableModel, SerializableModel};
 use super::ModelMessage;
 use crate::simulator::Services;
 use crate::utils::default_records_port_name;
@@ -187,11 +187,7 @@ impl LoadBalancer {
     }
 }
 
-impl AsModel for LoadBalancer {
-    fn status(&self) -> String {
-        format!["Listening for {}s", self.ports_in.job]
-    }
-
+impl DevsModel for LoadBalancer {
     fn events_ext(
         &mut self,
         incoming_message: &ModelMessage,
@@ -228,3 +224,11 @@ impl AsModel for LoadBalancer {
         self.state.until_next_event
     }
 }
+
+impl Reportable for LoadBalancer {
+    fn status(&self) -> String {
+        format!["Listening for {}s", self.ports_in.job]
+    }
+}
+
+impl ReportableModel for LoadBalancer {}

sim/src/models/mod.rs

@@ -3,6 +3,8 @@
 //! specifies the requirements of any additional custom models, via the
 //! `Model` trait.
 
+use serde::{Deserialize, Serialize};
+
 pub mod batcher;
 pub mod exclusive_gateway;
 pub mod gate;
@@ -25,7 +27,7 @@ pub use self::gate::Gate;
 pub use self::generator::Generator;
 pub use self::load_balancer::LoadBalancer;
 pub use self::model::Model;
-pub use self::model_trait::AsModel;
+pub use self::model_trait::{DevsModel, Reportable, ReportableModel};
 pub use self::parallel_gateway::ParallelGateway;
 pub use self::processor::Processor;
 pub use self::stochastic_gate::StochasticGate;
@@ -39,3 +41,10 @@ pub struct ModelMessage {
     pub port_name: String,
     pub content: String,
 }
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+pub struct ModelRecord {
+    pub time: f64,
+    pub action: String,
+    pub subject: String,
+}

sim/src/models/model.rs

@@ -1,7 +1,7 @@
 use serde::ser::SerializeMap;
 use serde::{Deserialize, Deserializer, Serialize, Serializer};
 
-use super::model_trait::{AsModel, SerializableModel};
+use super::model_trait::{DevsModel, Reportable, ReportableModel, SerializableModel};
 use super::ModelMessage;
 use crate::simulator::Services;
 use crate::utils::errors::SimulationError;
@@ -12,11 +12,11 @@ use crate::utils::errors::SimulationError;
 #[derive(Clone)]
 pub struct Model {
     id: String,
-    inner: Box<dyn AsModel>,
+    inner: Box<dyn ReportableModel>,
 }
 
 impl Model {
-    pub fn new(id: String, inner: Box<dyn AsModel>) -> Self {
+    pub fn new(id: String, inner: Box<dyn ReportableModel>) -> Self {
         Self { id, inner }
     }
 
@@ -51,11 +51,7 @@ impl<'de> Deserialize<'de> for Model {
 
 impl SerializableModel for Model {}
 
-impl AsModel for Model {
-    fn status(&self) -> String {
-        self.inner.status()
-    }
-
+impl DevsModel for Model {
     fn events_ext(
         &mut self,
         incoming_message: &ModelMessage,
@@ -79,3 +75,11 @@ impl AsModel for Model {
         self.inner.until_next_event()
     }
 }
+
+impl Reportable for Model {
+    fn status(&self) -> String {
+        self.inner.status()
+    }
+}
+
+impl ReportableModel for Model {}

sim/src/models/model_factory.rs

@@ -1,4 +1,4 @@
-use super::model_trait::AsModel;
+use super::model_trait::ReportableModel;
 use serde::de;
 use serde::Deserializer;
 use std::collections::HashMap;
@@ -7,7 +7,7 @@ use lazy_static::lazy_static;
 
 use std::sync::Mutex;
 
-pub type ModelConstructor = fn(serde_yaml::Value) -> Option<Box<dyn AsModel>>;
+pub type ModelConstructor = fn(serde_yaml::Value) -> Option<Box<dyn ReportableModel>>;
 lazy_static! {
     static ref CONSTRUCTORS: Mutex<HashMap<&'static str, ModelConstructor>> = {
         let mut m = HashMap::new();
@@ -65,7 +65,7 @@ pub fn register(model_type: &'static str, model_constructor: ModelConstructor) {
 pub fn create<'de, D: Deserializer<'de>>(
     model_type: &str,
     extra_fields: serde_yaml::Value,
-) -> Result<Box<dyn AsModel>, D::Error> {
+) -> Result<Box<dyn ReportableModel>, D::Error> {
     let model = match CONSTRUCTORS.lock().unwrap().get(model_type) {
         Some(constructor) => constructor(extra_fields),
         None => None,

sim/src/models/model_trait.rs

@@ -3,20 +3,20 @@ use crate::simulator::Services;
 use crate::utils::errors::SimulationError;
 
 pub trait ModelClone {
-    fn clone_box(&self) -> Box<dyn AsModel>;
+    fn clone_box(&self) -> Box<dyn ReportableModel>;
 }
 
 impl<T> ModelClone for T
 where
-    T: 'static + AsModel + Clone,
+    T: 'static + ReportableModel + Clone,
 {
-    fn clone_box(&self) -> Box<dyn AsModel> {
+    fn clone_box(&self) -> Box<dyn ReportableModel> {
         Box::new(self.clone())
     }
 }
 
-impl Clone for Box<dyn AsModel> {
-    fn clone(&self) -> Box<dyn AsModel> {
+impl Clone for Box<dyn ReportableModel> {
+    fn clone(&self) -> Box<dyn ReportableModel> {
         self.clone_box()
     }
 }
@@ -30,14 +30,11 @@ pub trait SerializableModel {
     }
 }
 
-/// The `AsModel` trait defines everything required for a model to operate
+/// The `DevsModel` trait defines everything required for a model to operate
 /// within the discrete event simulation.  The simulator formalism (Discrete
 /// Event System Specification) requires `events_ext`, `events_int`,
-/// `time_advance`, and `until_next_event`.  The additional `status` is for
-/// facilitation of simulation reasoning, reporting, and debugging.
-// #[enum_dispatch]
-pub trait AsModel: ModelClone + SerializableModel {
-    fn status(&self) -> String;
+/// `time_advance`, and `until_next_event`.
+pub trait DevsModel: ModelClone + SerializableModel {
     fn events_ext(
         &mut self,
         incoming_message: &ModelMessage,
@@ -48,3 +45,15 @@ pub trait AsModel: ModelClone + SerializableModel {
     fn time_advance(&mut self, time_delta: f64);
     fn until_next_event(&self) -> f64;
 }
+
+/// The additional status and record-keeping methods of `Reportable` provide
+/// improved simulation reasoning, reporting, and debugging, but do not
+/// impact simulation execution or results.
+pub trait Reportable {
+    fn status(&self) -> String;
+}
+
+/// A `ReportableModel` has the required Discrete Event System Specification
+/// methods of trait `DevsModel` and the status reporting and record keeping
+/// mechanisms of trait `Reportable`.
+pub trait ReportableModel: DevsModel + Reportable {}

sim/src/models/parallel_gateway.rs

@@ -3,7 +3,7 @@ use std::f64::INFINITY;
 
 use serde::{Deserialize, Serialize};
 
-use super::model_trait::{AsModel, SerializableModel};
+use super::model_trait::{DevsModel, Reportable, ReportableModel, SerializableModel};
 use super::ModelMessage;
 use crate::simulator::Services;
 use crate::utils::default_records_port_name;
@@ -216,11 +216,7 @@ impl ParallelGateway {
     }
 }
 
-impl AsModel for ParallelGateway {
-    fn status(&self) -> String {
-        String::from("Active")
-    }
-
+impl DevsModel for ParallelGateway {
     fn events_ext(
         &mut self,
         incoming_message: &ModelMessage,
@@ -261,3 +257,11 @@ impl AsModel for ParallelGateway {
         self.state.until_next_event
     }
 }
+
+impl Reportable for ParallelGateway {
+    fn status(&self) -> String {
+        String::from("Active")
+    }
+}
+
+impl ReportableModel for ParallelGateway {}