elevator-core 5.10.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

//! Service mode component for elevator operational modes.

use serde::{Deserialize, Serialize};

/// Operational service mode for an elevator, orthogonal to [`ElevatorPhase`](super::ElevatorPhase).
///
/// Normal is the default. Modes modify how simulation phases behave without
/// replacing `ElevatorPhase` — an elevator in any service mode may occupy
/// any phase (`Idle`, `MovingToStop`, `Repositioning`, etc.). `Independent`
/// elevators are excluded from automatic dispatch and repositioning, so in
/// practice they only move under direct API control.
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[non_exhaustive]
pub enum ServiceMode {
    /// Normal operation: dispatch assigns stops, doors auto-cycle.
    #[default]
    Normal,
    /// Independent mode: elevator is excluded from dispatch and repositioning.
    /// Consumer controls movement via direct API calls.
    Independent,
    /// Inspection mode: reduced speed, doors hold open indefinitely.
    /// Speed is reduced by [`Elevator::inspection_speed_factor`](super::Elevator::inspection_speed_factor).
    Inspection,
    /// Manual mode: elevator is driven by direct velocity commands from the
    /// game (see
    /// [`Simulation::set_target_velocity`](crate::sim::Simulation::set_target_velocity)
    /// and [`Simulation::emergency_stop`](crate::sim::Simulation::emergency_stop)).
    /// Excluded from dispatch and repositioning; doors follow the manual
    /// door-control API. Can stop at any position — the elevator is not
    /// required to align with a configured stop.
    Manual,
}

impl ServiceMode {
    /// `true` if elevators in this mode are skipped by the automatic
    /// dispatch and repositioning phases.
    ///
    /// Returns `true` for [`Independent`](Self::Independent) and
    /// [`Manual`](Self::Manual), which both hand elevator movement over
    /// to the consumer.
    #[must_use]
    pub const fn is_dispatch_excluded(self) -> bool {
        matches!(self, Self::Independent | Self::Manual)
    }
}

impl std::fmt::Display for ServiceMode {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Normal => write!(f, "Normal"),
            Self::Independent => write!(f, "Independent"),
            Self::Inspection => write!(f, "Inspection"),
            Self::Manual => write!(f, "Manual"),
        }
    }
}