Struct sim::simulator::Simulation

pub struct Simulation { /* fields omitted */ }

The Simulation struct is the core of sim, and includes everything needed to run a simulation - models, connectors, and a random number generator. State information, specifically global time and active messages are additionally retained in the struct.

Implementations

impl Simulation

pub fn post_json(models: &str, connectors: &str) -> Simulation

Like post_yaml, this constructor method creates a simulation from a supplied configuration (models and connectors).

pub fn put_json(&mut self, models: &str, connectors: &str)

Like put_yaml, this method sets the models and connectors of an existing simulation.

pub fn get_json(&self) -> String

This method provides the simulation state in a "pretty" serialized JSON format - with line breaks and indentations. The simulation details not included in this serialization are internal implementation details. If it is not included in the serialization, the data is not required to specify the simulation state, and it has been excluded deliberately.

pub fn post_yaml(models: &str, connectors: &str) -> Simulation

Like post_json, this constructor method creates a simulation from a supplied configuration (models and connectors).

pub fn put_yaml(&mut self, models: &str, connectors: &str)

Like put_json, this method sets the models and connectors of an existing simulation.

pub fn get_yaml(&self) -> String

This method provides the simulation state in a yaml serialized JSON format - with line breaks and indentations. The simulation details not included in this serialization are internal implementation details. If it is not included in the serialization, the data is not required to specify the simulation state, and it has been excluded deliberately.

pub fn get_messages_js(&self) -> Array

Simulation steps generate messages, which are then consumed on subsequent simulation steps. These messages between models in a simulation drive much of the discovery, analysis, and design. This accessor method provides the list of active messages, at the current point of time in the simulation. Message history is not retained, so simulation products and projects should collect messages as needed throughout the simulation execution.

pub fn get_messages_json(&self) -> String

This method is like get_messages_js, but returns the messages as JSON.

pub fn get_messages_yaml(&self) -> String

This method is like get_messages_js, but returns the messages as YAML.

pub fn get_global_time(&self) -> f64

An accessor method for the simulation global time.

pub fn status(&self, model_id: &str) -> String

This method provides a mechanism for getting the status of any model in a simulation. The method takes the model ID as an argument, and returns the current status string for that model.

pub fn reset(&mut self)

To enable simulation replications, the reset method resets the state of the simulation, except for the random number generator. Recreating a simulation from scratch for additional replications does not work, due to the random number generator seeding.

pub fn reset_messages(&mut self)

Clear the active messages in a simulation.

pub fn reset_global_time(&mut self)

Reset the simulation global time to 0.0.

pub fn inject_input(&mut self, message: Message)

Input injection creates a message during simulation execution, without needing to create that message through the standard simulation constructs. This enables live simulation interaction, disruption, and manipulation - all through the standard simulation message system.

pub fn inject_input_json(&mut self, message: &str)

This method is like inject_input, but the message is provided in JSON format.

pub fn inject_input_yaml(&mut self, message: &str)

This method is like inject_input, but the message is provided in YAML format.

pub fn step(&mut self)

The simulation step is foundational for a discrete event simulation. This method executes a single discrete event simulation step, including internal state transitions, external state transitions, message orchestration, and global time accounting.

pub fn step_until_js(&mut self, until: f64) -> Array

This method executes simulation step calls, until a global time has been exceeded. At which point, the messages from all the simulation steps are returned.

pub fn step_until_json(&mut self, until: f64) -> String

This method is like step_until_js, but returns the messages as JSON.

pub fn step_until_yaml(&mut self, until: f64) -> String

This method is like step_until_js, but returns the messages as YAML.

pub fn step_n_js(&mut self, n: usize) -> Array

This method executes the specified number of simulation steps, n. Upon execution of the n steps, the messages from all the steps are returned.

pub fn step_n_json(&mut self, n: usize) -> String

This method is like step_n_js, but returns the messages as JSON.

pub fn step_n_yaml(&mut self, n: usize) -> String

This method is like step_n_js, but returns the messages as YAML.

Trait Implementations

impl Clone for Simulation

fn clone(&self) -> Simulation

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Simulation

fn default() -> Simulation

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Simulation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl FromWasmAbi for Simulation

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for Simulation

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl OptionFromWasmAbi for Simulation

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a "none" instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Simulation

fn none() -> Self::Abi

Returns an ABI instance indicating "none", which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for Simulation

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, Simulation>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don't persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for Simulation

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, Simulation>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl Serialize for Simulation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl WasmDescribe for Simulation

fn describe()