Struct map_model::PathV2

pub struct PathV2 {
    steps: Vec<PathStepV2>,
    req: PathRequest,
    cost: Duration,
    uber_turns: Vec<UberTurnV2>,
}

A path between two endpoints for a particular mode. This representation is immutable and doesn’t prescribe specific lanes and turns to follow.

Fields

steps: Vec<PathStepV2>

req: PathRequest

cost: Duration

uber_turns: Vec<UberTurnV2>

Implementations

impl PathV2

pub(crate) fn new(
    steps: Vec<PathStepV2>,
    req: PathRequest,
    cost: Duration,
    uber_turns: Vec<UberTurnV2>
) -> PathV2

pub fn from_roads(
    roads: Vec<DirectedRoadID>,
    req: PathRequest,
    cost: Duration,
    uber_turns: Vec<UberTurnV2>,
    map: &Map
) -> PathV2

Vehicle implementations often just calculate the sequence of roads. Turn that into PathStepV2 here.

pub fn get_req(&self) -> &PathRequest

The original PathRequest used to produce this path.

pub fn get_steps(&self) -> &Vec<PathStepV2>

All steps in this path.

pub fn get_cost(&self) -> Duration

The time needed to perform this path. This time is not a lower bound; physically following the path might be faster. This time incorporates costs like using sub-optimal lanes, taking difficult turns, and crossing private roads (which are modelled with a large penalty!)

pub fn estimate_duration(
    &self,
    map: &Map,
    max_speed: Option<Speed>,
    main_road_penalty: Option<f64>
) -> Duration

Estimate how long following the path will take in the best case, assuming no traffic, delay at intersections, elevation, or penalties for crossing private roads. To determine the speed along each step, the agent’s optional max_speed must be known.

TODO Hack. The one use of this actually needs to apply main_road_penalty. We want to omit some penalties, but use others. Come up with a better way of expressing this.

pub fn into_v1(self, map: &Map) -> Result<Path>

Transform a sequence of roads representing a path into the current lane-based path, by picking particular lanes and turns to use.

fn into_v1_walking(self, map: &Map) -> Result<Path>

pub fn crosses_road(&self, r: RoadID) -> bool

pub fn trace_v2(&self, map: &Map) -> Result<Polygon>

Draws the thickened path, matching entire roads. Ignores the path’s exact starting and ending distance. Doesn’t handle contraflow yet.

pub fn trace_all_polygons(&self, map: &Map) -> Vec<Polygon>

Returns polygons covering the entire path. Ignores the path’s exact starting and ending distance.

Trait Implementations

impl Clone for PathV2

fn clone(&self) -> PathV2

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PathV2

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PathV2

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PathV2

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.