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

//! Stop (floor/station) component.

use serde::{Deserialize, Serialize};

/// Component for a stop (floor/station) entity.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Stop {
    /// Human-readable stop name.
    pub(crate) name: String,
    /// Absolute position along the shaft axis.
    pub(crate) position: f64,
}

impl Stop {
    /// Human-readable stop name.
    #[must_use]
    pub fn name(&self) -> &str {
        &self.name
    }

    /// Absolute position along the shaft axis.
    #[must_use]
    pub const fn position(&self) -> f64 {
        self.position
    }
}