Struct openrailwaymap_exporter::simulation::Simulation

pub struct Simulation {
    pub environment: SimulationEnvironment,
    pub object_agents: HashMap<RailwayObjectId, Box<dyn DecisionAgent<A = RailMovableAction>>>,
    pub metrics_handlers: Vec<Box<dyn MetricsHandler>>,
    pub is_paused: bool,
    pub speedup_factor: f64,
    /* private fields */
}

A Simulation struct holding a railway graph and a list of moveable railway objects.

Fields

environment: SimulationEnvironment

The simulation environment

object_agents: HashMap<RailwayObjectId, Box<dyn DecisionAgent<A = RailMovableAction>>>

A list of agents

metrics_handlers: Vec<Box<dyn MetricsHandler>>

A list of metrics handlers

is_paused: bool

simulation pause state

speedup_factor: f64

Speedup factor of the simulation

Implementations

impl Simulation

pub fn new(graph: RailwayGraph) -> Self

Creates a new simulation with the given railway graph.

Arguments

• graph - The railway graph representing the railway infrastructure.

Returns

A new Simulation instance.

pub fn get_observable_environment( &self ) -> &(dyn ObservableEnvironment + 'static)

Returns a reference to the observable environment of the simulation.

The observable environment allows external components to access the state of the simulation without being able to modify it. This is useful for agents to observe the simulation state and make decisions based on it.

Returns

A reference to a trait object implementing the ObservableEnvironment trait, which provides read-only access to the simulation environment.

pub fn add_object( &mut self, object: Box<dyn SimulationObject>, agent: Option<Box<dyn DecisionAgent<A = RailMovableAction>>> ) -> bool

Adds a moveable railway object to the simulation.

Arguments

• object - The moveable railway object to be added to the simulation.

Returns

A boolean indicating if the object was successfully added.

pub fn remove_object(&mut self, id: i64) -> bool

Removes a moveable railway object from the simulation.

Arguments

• id - The unique identifier of the moveable railway object to be removed.

Returns

A boolean indicating if the object was successfully removed.

pub fn add_agent_for_object( &mut self, object_id: RailwayObjectId, agent: Box<dyn DecisionAgent<A = RailMovableAction>> ) -> bool

Adds a decision agent for an object in the simulation.

Arguments

• object_id - The unique identifier of the object.
• agent - The decision agent to be added.

Returns

A boolean indicating if the agent was successfully added.

pub fn register_metrics_handler(&mut self, handler: Box<dyn MetricsHandler>)

Registers a metrics handler for the simulation.

This function adds a new metrics handler to the simulation. The metrics handler will be used to process events and gather metrics during the simulation run.

Arguments

• handler - A boxed metrics handler that implements the MetricsHandler trait.

pub fn update(&mut self, delta_time: Duration)

Updates the simulation state based on the given delta time and the speedup factor.

Arguments

• delta_time - The elapsed time since the last update.

Trait Implementations

impl Debug for Simulation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Send for Simulation

impl Sync for Simulation