Struct sbp::time::GpsTime

pub struct GpsTime(/* private fields */);

Representation of GPS Time

Implementations

impl GpsTime

pub fn new(wn: i16, tow: f64) -> Result<GpsTime, InvalidGpsTime>

Makes a new GPS time object and checks the validity of the given values.

Invalid values include negative week values, negative, non-finite, or to large time of week values.

pub fn wn(&self) -> i16

Gets the week number

pub fn tow(&self) -> f64

Gets the time of week

pub fn is_valid(&self) -> bool

Checks if the stored time is valid

pub fn add_duration(&mut self, duration: &Duration)

Adds a duration to the time

pub fn subtract_duration(&mut self, duration: &Duration)

Subtracts a duration from the time

pub fn diff(&self, other: &GpsTime) -> f64

Gets the difference between this and another time value in seconds

pub fn to_utc(self, utc_params: &UtcParams) -> UtcTime

Converts the GPS time into UTC time

Panics

This function will panic if the GPS time is not valid

pub fn to_utc_hardcoded(self) -> UtcTime

Converts the GPS time into UTC time using the hardcoded list of leap seconds.

⚠️ 🦘 ⏱ ⚠️ - Leap Seconds

The hard coded list of leap seconds will get out of date, it is preferable to use GpsTime::to_utc() with the newest set of UTC parameters

Panics

This function will panic if the GPS time is not valid

pub fn utc_offset(&self, utc_params: &UtcParams) -> f64

Gets the number of seconds difference between GPS and UTC times

pub fn utc_offset_hardcoded(&self) -> f64

Gets the number of seconds difference between GPS and UTC using the hardcoded list of leap seconds

⚠️ 🦘 ⏱ ⚠️ - Leap Seconds

The hard coded list of leap seconds will get out of date, it is preferable to use GpsTime::utc_offset() with the newest set of UTC parameters

pub fn is_leap_second_event(&self, utc_params: &UtcParams) -> bool

Checks to see if this point in time is a UTC leap second event

pub fn is_leap_second_event_hardcoded(&self) -> bool

Checks to see if this point in time is a UTC leap second event using the hardcoded list of leap seconds

⚠️ 🦘 ⏱ ⚠️ - Leap Seconds

The hard coded list of leap seconds will get out of date, it is preferable to use GpsTime::is_leap_second_event() with the newest set of UTC parameters

pub fn round_to_epoch(&self, soln_freq: f64) -> GpsTime

Gets the GPS time of the nearest solution epoch

pub fn floor_to_epoch(&self, soln_freq: f64) -> GpsTime

Gets the GPS time of the previous solution epoch

pub fn to_gal(self) -> GalTime

Converts the GPS time into Galileo time

Panics

This function will panic if the GPS time is before the start of Galileo time, i.e. GAL_TIME_START

pub fn to_bds(self) -> BdsTime

Converts the GPS time into Beidou time

Panics

This function will panic if the GPS time is before the start of Beidou time, i.e. BDS_TIME_START

pub fn to_glo(self, utc_params: &UtcParams) -> GloTime

Converts a GPS time into a Glonass time

Panics

This function will panic if the GPS time is before the start of Glonass time, i.e. GLO_TIME_START

pub fn to_glo_hardcoded(self) -> GloTime

Converts a GPS time into a Glonass time using the hardcoded list of leap seconds.

⚠️ 🦘 ⏱ ⚠️ - Leap Seconds

The hard coded list of leap seconds will get out of date, it is preferable to use GpsTime::to_glo() with the newest set of UTC parameters

Panics

This function will panic if the GPS time is before the start of Glonass time, i.e. GLO_TIME_START

pub fn total_cmp(&self, other: &GpsTime) -> Ordering

Compare between itself and other GpsTime Checks whether week number is same which then mirrors f64::total_cmp()

Trait Implementations

impl Add<Duration> for GpsTime

type Output = GpsTime

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> GpsTime

Performs the + operation.

impl AddAssign<Duration> for GpsTime

fn add_assign(&mut self, rhs: Duration)

Performs the += operation.

impl Clone for GpsTime

fn clone(&self) -> GpsTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GpsTime

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

Formats the value using the given formatter.

impl From<BdsTime> for GpsTime

fn from(bds: BdsTime) -> GpsTime

Converts to this type from the input type.

impl From<GalTime> for GpsTime

fn from(gal: GalTime) -> GpsTime

Converts to this type from the input type.

impl From<GpsTime> for BaseTime

fn from(gps_time: GpsTime) -> Self

Converts to this type from the input type.

impl From<GpsTime> for RoverTime

fn from(gps_time: GpsTime) -> Self

Converts to this type from the input type.

impl PartialEq for GpsTime

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for GpsTime

fn partial_cmp(&self, other: &GpsTime) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<&GpsTime> for GpsTime

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, rhs: &GpsTime) -> Duration

Performs the - operation.

impl Sub<Duration> for GpsTime

type Output = GpsTime

The resulting type after applying the - operator.

fn sub(self, rhs: Duration) -> <GpsTime as Sub<Duration>>::Output

Performs the - operation.

impl Sub for GpsTime

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, rhs: GpsTime) -> Duration

Performs the - operation.

impl SubAssign<Duration> for GpsTime

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation.

impl TryFrom<GpsTime> for GpsTime

type Error = InvalidGpsTime

The type returned in the event of a conversion error.

fn try_from(msg: GpsTime) -> Result<GpsTime, InvalidGpsTime>

Performs the conversion.

impl TryFrom<GpsTimeSec> for GpsTime

type Error = InvalidGpsTime

The type returned in the event of a conversion error.

fn try_from(msg: GpsTimeSec) -> Result<GpsTime, InvalidGpsTime>

Performs the conversion.

impl Copy for GpsTime