Struct Route 

pub struct Route { /* private fields */ }

A route that goes from an origin to a destination.

The route is composed of legs where each leg describes path between two fixes.

Decoding

The route can be decoded from a space separated list of fixes, wind values and performance elements. The route elements

13509KT N0107 EDDH D DCT W EDHL

would create a route from Hamburg to Luebeck via outbound delta routing and inbound whisky routing with a desired TAS of 107kt and a wind of 9kt from south-east. Performance elements can be add at any point but latest before the first leg is defined (we have from and to fix).

Thus, each leg is computed based on the latest performance elements defined on the route. Extending our route to

13509KT N0107 EDDH D DCT 18009KT DCT W EDHL

we would have wind from south-east (135°) on the leg from EDDH to D (VRP Delta), but the wind would turn to south (180°) for the remaining legs.

Implementations

impl Route

pub fn new() -> Self

pub fn decode(&mut self, route: &str, nd: &NavigationData) -> Result<(), Error>

Decodes a route that is composed of a space separated list of fix idents read from the navigation data nd.

pub fn tokens(&self) -> &[Token]

Returns the tokens used to build the route.

pub fn clear(&mut self)

Clears the route elements, legs and alternate.

pub fn legs(&self) -> &[Leg]

Returns the legs of the route.

pub fn set_cruise( &mut self, _speed: Option<Speed>, _level: Option<VerticalDistance>, )

Sets the cruise speed and level.

The cruise speed or level is remove from the route by setting it to None.

pub fn speed(&self) -> Option<Speed>

pub fn level(&self) -> Option<VerticalDistance>

pub fn set_alternate(&mut self, alternate: Option<NavAid>)

Sets an alternate on the route.

The alternate is remove by setting it to None.

pub fn alternate(&self) -> Option<Leg>

Returns the final leg but going to the alternate.

pub fn origin(&self) -> Option<Rc<Airport>>

Returns the origin airport if one is defined in the route.

pub fn takeoff_rwy(&self) -> Option<&Runway>

Returns the takeoff runway if a defined in the route.

pub fn destination(&self) -> Option<Rc<Airport>>

Returns the destination airport if one is defined in the route.

pub fn landing_rwy(&self) -> Option<&Runway>

Returns the landing runway if a defined in the route.

pub fn accumulate_legs<'a>( &'a self, perf: Option<&'a Performance>, ) -> impl Iterator<Item = TotalsToLeg> + 'a

Returns an iterator that accumulates totals progressively through each leg of the route.

This function provides cumulative totals from the route start up to each leg. Each yielded TotalsToLeg represents the accumulated totals from the beginning of the route to that specific leg. If Some performance is provided, the fuel will be accumulated too.

Examples

// Iterate through route showing progressive totals
for (i, totals) in route.accumulate_legs(Some(&perf)).enumerate() {
    println!("Leg {}: Total distance: {}, Total fuel: {:?}",
             i + 1, totals.dist(), totals.fuel());
}

Note

If any leg in the sequence is missing ETE or fuel data, the cumulative ETE/fuel will be None for that leg and all subsequent legs, following an “all-or-nothing” approach to ensure data consistency.

pub fn totals(&self, perf: Option<&Performance>) -> Option<TotalsToLeg>

Returns the totals of the entire route.

pub fn vertical_profile(&self, nd: &NavigationData) -> VerticalProfile

Returns the vertical profile showing all airspace intersections along this route.

The profile contains entry and exit points for each airspace the route passes through, sorted by distance from the route start.

Examples

let profile = route.vertical_profile(nd);

for intersection in profile.intersections() {
    println!("{}: {:.1} NM to {:.1} NM",
        intersection.airspace().name,
        intersection.entry_distance().value(),
        intersection.exit_distance().value());
}

impl Route

pub fn to_geojson(&self) -> GeoJson

Available on crate feature geojson only.

Returns the route’s legs as GeoJSON with a line string geometry.

Trait Implementations

impl Clone for Route

fn clone(&self) -> Route

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Route

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

Formats the value using the given formatter.

impl Default for Route

fn default() -> Route

Returns the “default value” for a type.

impl Display for Route

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

Formats the value using the given formatter.

impl PartialEq for Route

fn eq(&self, other: &Route) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Route