elevator-core 5.2.0

Engine-agnostic elevator simulation library with pluggable dispatch strategies
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

use crate::events::Event;
use crate::stop::StopId;

use super::helpers::{default_config, scan};

#[test]
fn per_phase_methods_equivalent_to_step() {
    let config = default_config();

    // Sim A: use step()
    let mut sim_a = crate::sim::Simulation::new(&config, scan()).unwrap();
    sim_a
        .spawn_rider_by_stop_id(StopId(0), StopId(2), 70.0)
        .unwrap();
    for _ in 0..100 {
        sim_a.step();
    }

    // Sim B: use individual phases
    let mut sim_b = crate::sim::Simulation::new(&config, scan()).unwrap();
    sim_b
        .spawn_rider_by_stop_id(StopId(0), StopId(2), 70.0)
        .unwrap();
    for _ in 0..100 {
        sim_b.run_advance_transient();
        sim_b.run_dispatch();
        sim_b.run_movement();
        sim_b.run_doors();
        sim_b.run_loading();
        sim_b.run_metrics();
        sim_b.advance_tick();
    }

    // Both should be at the same tick.
    assert_eq!(sim_a.current_tick(), sim_b.current_tick());

    // Both should have the same metrics.
    assert_eq!(
        sim_a.metrics().total_delivered,
        sim_b.metrics().total_delivered
    );
    assert_eq!(sim_a.metrics().total_spawned, sim_b.metrics().total_spawned);
}

#[test]
fn advance_tick_increments_tick() {
    let config = default_config();
    let mut sim = crate::sim::Simulation::new(&config, scan()).unwrap();
    assert_eq!(sim.current_tick(), 0);
    sim.advance_tick();
    assert_eq!(sim.current_tick(), 1);
    sim.advance_tick();
    assert_eq!(sim.current_tick(), 2);
}

#[test]
fn phase_context_reflects_current_tick() {
    let config = default_config();
    let mut sim = crate::sim::Simulation::new(&config, scan()).unwrap();
    let ctx = sim.phase_context();
    assert_eq!(ctx.tick, 0);

    sim.advance_tick();
    let ctx = sim.phase_context();
    assert_eq!(ctx.tick, 1);
}

#[test]
fn elevator_assigned_event_emitted() {
    let config = default_config();
    let mut sim = crate::sim::Simulation::new(&config, scan()).unwrap();

    sim.spawn_rider_by_stop_id(StopId(0), StopId(2), 70.0)
        .unwrap();
    sim.drain_events(); // clear spawn event

    sim.run_advance_transient();
    sim.run_dispatch();

    let events = sim.drain_events();
    assert!(
        events
            .iter()
            .any(|e| matches!(e, Event::ElevatorAssigned { .. }))
    );
}

#[test]
fn events_mut_allows_custom_emission() {
    let config = default_config();
    let mut sim = crate::sim::Simulation::new(&config, scan()).unwrap();

    // Games can emit custom sim events through events_mut.
    let elev = sim.world().elevator_ids()[0];
    let stop = sim.stop_entity(StopId(0)).unwrap();
    sim.events_mut().emit(Event::ElevatorDeparted {
        elevator: elev,
        from_stop: stop,
        tick: 999,
    });

    let events = sim.drain_events();
    assert!(
        events
            .iter()
            .any(|e| matches!(e, Event::ElevatorDeparted { tick: 999, .. }))
    );
}