Struct TrackError 

pub struct TrackError {
    pub cross_track_nm: f64,
    pub along_track_nm: f64,
}

Where a vessel sits relative to the leg from -> to.

Fields

cross_track_nm: f64

Perpendicular distance off the leg, nautical miles, positive when the vessel is to starboard of the track.

The sign is the one a helm display needs inverted: positive here means “steer to port to get back”. NMEA’s XTE sentence instead carries a magnitude plus an L/R letter naming the direction to steer, so an adapter emitting XTE must flip this, not copy it.

along_track_nm: f64

Distance from from measured along the leg, nautical miles.

Negative when the vessel has not yet reached from (it lies behind the start of the leg), and greater than the leg length once past to. Both cases are normal and are how leg advance is detected.

Implementations

impl TrackError

pub fn remaining_nm(&self, leg_length_nm: f64) -> f64

Distance still to run along the leg, negative once past to.

Trait Implementations

impl Clone for TrackError

fn clone(&self) -> TrackError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TrackError

impl Debug for TrackError

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

Formats the value using the given formatter.

impl PartialEq for TrackError

fn eq(&self, other: &TrackError) -> 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 TrackError