micro_traffic_sim_core 0.1.9

Core library for microscopic traffic simulation via cellular automata.
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

use std::fmt;

/// ZoneType gives meaning to the cell in terms of its application.
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum ZoneType {
    // Default uninitialized state
    Undefined = 0,
    // Vehicles spawn here
    Birth,
    // Vehicles despawn here
    Death,
    // Junction/intersection cell requiring conflict resolution
    Coordination,
    // Regular road segment
    Common,
    // Cell that is disconnected from the road network (for future use)
    Isolated,
    // Dedicated bus lane (for future use)
    LaneForBus,
    // Relaxation cells (stops basically) for public transport vehicles (for future use)
    Transit,
    // Pedestrian crossing area (for future use)
    Crosswalk,
}

impl fmt::Display for ZoneType {
    /// Formats the zone type for display.
    /// 
    /// Returns a short, lowercase string representation suitable for
    /// logging, debugging, and user interfaces.
    /// 
    /// # Examples
    /// 
    /// ```rust
    /// use micro_traffic_sim_core::grid::zones::ZoneType;
    ///
    /// assert_eq!(format!("{}", ZoneType::Undefined), "undefined");
    /// assert_eq!(format!("{}", ZoneType::Birth), "birth");
    /// assert_eq!(format!("{}", ZoneType::Death), "death");
    /// assert_eq!(format!("{}", ZoneType::Coordination), "coordination");
    /// assert_eq!(format!("{}", ZoneType::Common), "common");
    /// assert_eq!(format!("{}", ZoneType::Isolated), "isolated");
    /// assert_eq!(format!("{}", ZoneType::LaneForBus), "bus_lane");
    /// assert_eq!(format!("{}", ZoneType::Transit), "transit");
    /// assert_eq!(format!("{}", ZoneType::Crosswalk), "crosswalk");
    /// ```
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            ZoneType::Undefined => write!(f, "undefined"),
            ZoneType::Birth => write!(f, "birth"),
            ZoneType::Death => write!(f, "death"),
            ZoneType::Coordination => write!(f, "coordination"),
            ZoneType::Common => write!(f, "common"),
            ZoneType::Isolated => write!(f, "isolated"),
            ZoneType::LaneForBus => write!(f, "bus_lane"),
            ZoneType::Transit => write!(f, "transit"),
            ZoneType::Crosswalk => write!(f, "crosswalk"),
        }
    }
}