Struct VesselState 

pub struct VesselState {
    pub position: Position,
    pub cog_deg: f64,
    pub sog_kn: f64,
    pub heading_deg: Option<f64>,
}

What a client knows about own ship at one instant.

Fields

position: Position

Where the vessel is.

cog_deg: f64

Course over ground, degrees true.

sog_kn: f64

Speed over ground, knots.

heading_deg: Option<f64>

Heading, degrees true, when the vessel has a compass.

Differs from course when there is leeway or current. None when the vessel has no heading sensor; substituting course in that case would misrepresent a measurement as heading.

Implementations

impl VesselState

pub fn predictor_end(&self) -> Position

The far end of the course predictor: where the vessel reaches if it holds this course and speed for PREDICTOR_MINUTES.

pub fn heading_line_end(&self) -> Option<Position>

The far end of the heading line: where the bow points, which differs from the course over ground under leeway or current.

Length matches the course predictor so the angle between them is directly comparable, with a floor (MIN_HEADING_LINE_NM) so the line stays visible for a vessel stopped in a tideway. None when there is no compass; no line is drawn in that case.

Trait Implementations

impl Clone for VesselState

fn clone(&self) -> VesselState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for VesselState

impl Debug for VesselState

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

Formats the value using the given formatter.

impl PartialEq for VesselState

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