Struct EnvironmentSample 

pub struct EnvironmentSample { /* private fields */ }

Environment resolved for one point and instant.

Values, not sources: built from whichever models are available and passed to calculations that need no port. Unresolved quantities are None, never zero.

Implementations

impl EnvironmentSample

pub const fn at(point: GeodeticPoint, when: Instant<Utc>) -> Self

Empty sample for point at when.

pub const fn with_magnetic(self, field: MagneticField) -> Self

Sets the magnetic field.

pub const fn with_current(self, current: Current) -> Self

Sets the current.

pub const fn with_wind(self, wind: Wind) -> Self

Sets the wind.

pub const fn with_tide(self, height: Distance) -> Self

Sets the height of tide above chart datum.

Where there is no tide, set Distance::ZERO: an unset tide means “not asked”, and calculations needing it report that instead of assuming zero.

pub const fn point(&self) -> GeodeticPoint

Point of the sample.

pub const fn when(&self) -> Instant<Utc>

Time of the sample.

pub const fn magnetic(&self) -> Option<MagneticField>

Magnetic field, if resolved.

pub const fn current(&self) -> Option<Current>

Current, if resolved.

pub const fn wind(&self) -> Option<Wind>

Wind, if resolved.

pub const fn tide(&self) -> Option<Distance>

Height of tide above chart datum, if resolved.

Trait Implementations

impl Clone for EnvironmentSample

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EnvironmentSample

impl Debug for EnvironmentSample

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

Formats the value using the given formatter.

impl PartialEq for EnvironmentSample

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EnvironmentSample