bambam 0.3.1

The Behavior and Advanced Mobility Big Access 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

use super::TimeDelayLookup;
use bambam_core::model::bambam_state;
use routee_compass_core::{
    algorithm::search::SearchTree,
    model::{
        network::{Edge, Vertex},
        state::{InputFeature, StateModel, StateVariable, StateVariableConfig},
        traversal::{
            EdgeFrontierContext, TraversalModel, TraversalModelError, TraversalModelService,
        },
    },
};
use std::sync::Arc;
use uom::{
    si::f64::{Length, Time},
    ConstZero,
};

/// assigns time delays for trips that have a delay from the start of their trip.
/// for within-trip delays assigned to beginning travel in a mode, use a delay
/// during mode switch instead (doesn't exist yet)
pub struct TripDepartureDelayModel(Arc<TimeDelayLookup>);

impl TripDepartureDelayModel {
    pub fn new(lookup: Arc<TimeDelayLookup>) -> TripDepartureDelayModel {
        TripDepartureDelayModel(lookup)
    }
}

impl TraversalModelService for TripDepartureDelayModel {
    fn build(
        &self,
        query: &serde_json::Value,
    ) -> Result<Arc<dyn TraversalModel>, TraversalModelError> {
        let model: Arc<dyn TraversalModel> = Arc::new(Self::new(self.0.clone()));
        Ok(model)
    }
}

impl TraversalModel for TripDepartureDelayModel {
    fn name(&self) -> String {
        "Trip Departure Delay Traversal Model".to_string()
    }

    fn input_features(&self) -> Vec<InputFeature> {
        vec![]
    }

    fn output_features(&self) -> Vec<(String, StateVariableConfig)> {
        vec![
            (
                bambam_state::TRIP_TIME.to_string(),
                StateVariableConfig::Time {
                    initial: Time::ZERO,
                    output_unit: Some(self.0.config.time_unit),
                    accumulator: false,
                },
            ),
            (
                bambam_state::TRIP_ENROUTE_DELAY.to_string(),
                StateVariableConfig::Time {
                    initial: Time::ZERO,
                    output_unit: Some(self.0.config.time_unit),
                    accumulator: false,
                },
            ),
        ]
    }

    fn estimate_traversal(
        &self,
        od: (&Vertex, &Vertex),
        state: &mut Vec<StateVariable>,
        _tree: &SearchTree,
        state_model: &StateModel,
    ) -> Result<(), TraversalModelError> {
        let (origin, _) = od;
        add_delay_time(origin, state, state_model, self.0.clone())
    }

    fn traverse_edge(
        &self,
        ctx: &EdgeFrontierContext,
        state: &mut Vec<StateVariable>,
        state_model: &StateModel,
    ) -> Result<(), TraversalModelError> {
        add_delay_time(ctx.src, state, state_model, self.0.clone())
    }
}

/// if trip is departing from the origin, apply the trip departure delay.
fn add_delay_time(
    origin: &Vertex,
    state: &mut [StateVariable],
    state_model: &StateModel,
    lookup: Arc<TimeDelayLookup>,
) -> Result<(), TraversalModelError> {
    let distance = state_model.get_distance(state, bambam_state::TRIP_DISTANCE)?;
    if distance == Length::ZERO {
        return Ok(());
    }
    if let Some(delay) = lookup.get_delay_for_vertex(origin) {
        state_model.set_time(state, bambam_state::TRIP_ENROUTE_DELAY, &delay)?;
        state_model.add_time(state, bambam_state::TRIP_TIME, &delay)?;
    }
    Ok(())
}