macro_traffic_sim_core 0.1.0

Core library for macroscopic traffic simulation using the classical 4-step demand model.
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
109
110
111
112
113
114
115
116
117
118
119
120

//! # Error Module
//!
//! Top-level error type that aggregates domain-specific errors
//! from each module.
//!
//! ## Variants
//!
//! Each variant wraps a domain-specific error:
//!
//! - [`SimError::Graph`] -- network structure errors
//! - [`SimError::TripGeneration`] -- step 1 errors
//! - [`SimError::TripDistribution`] -- step 2 errors
//! - [`SimError::ModeChoice`] -- step 3 errors
//! - [`SimError::Assignment`] -- step 4 errors
//! - [`SimError::Pipeline`] -- orchestration errors
//!
//! ## Examples
//!
//! ```
//! use macro_traffic_sim_core::error::SimError;
//! use macro_traffic_sim_core::gmns::error::GraphError;
//!
//! let graph_err = GraphError::NodeNotFound { node_id: 99 };
//! let sim_err: SimError = graph_err.into();
//! assert_eq!(sim_err.to_string(), "graph error: node not found: 99");
//! ```

use std::fmt;

use crate::assignment::error::AssignmentError;
use crate::gmns::error::GraphError;
use crate::mode_choice::error::ModeChoiceError;
use crate::pipeline::error::PipelineError;
use crate::trip_distribution::error::TripDistributionError;
use crate::trip_generation::error::TripGenerationError;

/// Top-level error type for the macro traffic simulation.
///
/// Each variant wraps a domain-specific error defined in its own module.
///
/// All domain errors implement `From<T> for SimError`, so the `?`
/// operator works transparently across module boundaries.
///
/// # Examples
///
/// ```
/// use macro_traffic_sim_core::error::SimError;
/// use macro_traffic_sim_core::pipeline::error::PipelineError;
///
/// let err = PipelineError::InvalidConfig("bad param".to_string());
/// let sim_err: SimError = err.into();
/// assert_eq!(
///     sim_err.to_string(),
///     "pipeline error: invalid config: bad param"
/// );
/// ```
#[derive(Debug, Clone)]
pub enum SimError {
    /// Graph-related errors (nodes, links, zones).
    Graph(GraphError),
    /// Trip generation errors (Step 1).
    TripGeneration(TripGenerationError),
    /// Trip distribution errors (Step 2).
    TripDistribution(TripDistributionError),
    /// Mode choice errors (Step 3).
    ModeChoice(ModeChoiceError),
    /// Traffic assignment errors (Step 4).
    Assignment(AssignmentError),
    /// Pipeline orchestration errors.
    Pipeline(PipelineError),
}

impl fmt::Display for SimError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            SimError::Graph(e) => write!(f, "graph error: {}", e),
            SimError::TripGeneration(e) => write!(f, "trip generation error: {}", e),
            SimError::TripDistribution(e) => write!(f, "trip distribution error: {}", e),
            SimError::ModeChoice(e) => write!(f, "mode choice error: {}", e),
            SimError::Assignment(e) => write!(f, "assignment error: {}", e),
            SimError::Pipeline(e) => write!(f, "pipeline error: {}", e),
        }
    }
}

impl From<GraphError> for SimError {
    fn from(e: GraphError) -> Self {
        SimError::Graph(e)
    }
}

impl From<TripGenerationError> for SimError {
    fn from(e: TripGenerationError) -> Self {
        SimError::TripGeneration(e)
    }
}

impl From<TripDistributionError> for SimError {
    fn from(e: TripDistributionError) -> Self {
        SimError::TripDistribution(e)
    }
}

impl From<ModeChoiceError> for SimError {
    fn from(e: ModeChoiceError) -> Self {
        SimError::ModeChoice(e)
    }
}

impl From<AssignmentError> for SimError {
    fn from(e: AssignmentError) -> Self {
        SimError::Assignment(e)
    }
}

impl From<PipelineError> for SimError {
    fn from(e: PipelineError) -> Self {
        SimError::Pipeline(e)
    }
}