Struct hifitime::Epoch

pub struct Epoch(_);

Defines an Epoch in TAI (temps atomique international) in seconds past 1900 January 01 at midnight (like the Network Time Protocol).

Refer to the appropriate functions for initializing this Epoch from different time systems or representations.

Methods

impl Epoch

pub fn from_tai_seconds(seconds: f64) -> Self

Initialize an Epoch from the provided TAI seconds since 1900 January 01 at midnight

pub fn from_tai_days(days: f64) -> Self

Initialize an Epoch from the provided TAI days since 1900 January 01 at midnight

pub fn from_mjd_tai(days: f64) -> Self

pub fn from_jde_tai(days: f64) -> Self

pub fn from_tt_seconds(seconds: f64) -> Self

Initialize an Epoch from the provided TT seconds (approximated to 32.184s delta from TAI)

pub fn from_et_seconds(seconds: f64) -> Epoch

Initialize from SPICE ephemeris time (same as Dynamic Barycentric Time (TBD)) whose epoch is 2000 JAN 01 noon TAI

pub fn from_jde_et(days: f64) -> Self

Initialize from SPICE ephemeris time in JD days

pub fn maybe_from_gregorian_tai(
    year: i32,
    month: u8,
    day: u8,
    hour: u8,
    minute: u8,
    second: u8,
    nanos: u32
) -> Result<Self, Errors>

Attempts to build an Epoch from the provided Gregorian date and time in TAI.

pub fn from_gregorian_tai(
    year: i32,
    month: u8,
    day: u8,
    hour: u8,
    minute: u8,
    second: u8,
    nanos: u32
) -> Self

Builds an Epoch from the provided Gregorian date and time in TAI. If invalid date is provided, this function will panic. Use maybe_from_gregorian_tai if unsure.

pub fn from_gregorian_tai_at_midnight(year: i32, month: u8, day: u8) -> Self

pub fn from_gregorian_tai_at_noon(year: i32, month: u8, day: u8) -> Self

pub fn from_gregorian_tai_hms(
    year: i32,
    month: u8,
    day: u8,
    hour: u8,
    minute: u8,
    second: u8
) -> Self

pub fn maybe_from_gregorian_utc(
    year: i32,
    month: u8,
    day: u8,
    hour: u8,
    minute: u8,
    second: u8,
    nanos: u32
) -> Result<Self, Errors>

Attempts to build an Epoch from the provided Gregorian date and time in UTC.

pub fn from_gregorian_utc(
    year: i32,
    month: u8,
    day: u8,
    hour: u8,
    minute: u8,
    second: u8,
    nanos: u32
) -> Self

Builds an Epoch from the provided Gregorian date and time in TAI. If invalid date is provided, this function will panic. Use maybe_from_gregorian_tai if unsure.

pub fn from_gregorian_utc_at_midnight(year: i32, month: u8, day: u8) -> Self

pub fn from_gregorian_utc_at_noon(year: i32, month: u8, day: u8) -> Self

pub fn from_gregorian_utc_hms(
    year: i32,
    month: u8,
    day: u8,
    hour: u8,
    minute: u8,
    second: u8
) -> Self

pub fn as_tai_seconds(self) -> f64

pub fn as_tai_days(self) -> f64

pub fn as_utc_seconds(self) -> f64

Returns the number of UTC seconds since the TAI epoch

pub fn as_utc_days(self) -> f64

pub fn as_mjd_tai_days(self) -> f64

as_mjd_days creates an Epoch from the provided Modified Julian Date in days as explained here. MJD epoch is Modified Julian Day at 17 November 1858 at midnight.

pub fn as_mjd_utc_days(self) -> f64

Returns the Modified Julian Date in days UTC.

pub fn as_mjd_tai_seconds(self) -> f64

Returns the Modified Julian Date in seconds TAI.

pub fn as_mjd_utc_seconds(self) -> f64

Returns the Modified Julian Date in seconds UTC.

pub fn as_jde_tai_days(self) -> f64

Returns the Julian days from epoch 01 Jan -4713, 12:00 (noon) as explained in "Fundamentals of astrodynamics and applications", Vallado et al. 4th edition, page 182, and on Wikipedia.

pub fn as_jde_tai_seconds(self) -> f64

Returns the Julian seconds in TAI.

pub fn as_jde_utc_days(self) -> f64

Returns the Julian days in UTC.

pub fn as_jde_utc_seconds(self) -> f64

Returns the Julian seconds in UTC.

pub fn as_tt_seconds(self) -> f64

Returns seconds past TAI epoch in Terrestrial Time (TT) (previously called Terrestrial Dynamical Time (TDT))

pub fn as_jde_tt_days(self) -> f64

Returns days past Julian epoch in Terrestrial Time (TT) (previously called Terrestrial Dynamical Time (TDT))

pub fn as_mjd_tt_days(self) -> f64

Returns days past Modified Julian epoch in Terrestrial Time (TT) (previously called Terrestrial Dynamical Time (TDT))

pub fn as_gpst_seconds(self) -> f64

Returns seconds past GPS Time Epoch, defined as UTC midnight of January 5th to 6th 1980 (cf. https://gssc.esa.int/navipedia/index.php/Time_References_in_GNSS#GPS_Time_.28GPST.29).

pub fn as_gpst_days(self) -> f64

Returns days past GPS Time Epoch, defined as UTC midnight of January 5th to 6th 1980 (cf. https://gssc.esa.int/navipedia/index.php/Time_References_in_GNSS#GPS_Time_.28GPST.29).

pub fn as_et_seconds(self) -> f64

pub fn as_jde_et_days(self) -> f64

pub fn mut_add_days(&mut self, days: f64)

Increment this epoch by the number of days provided.

pub fn mut_add_secs(&mut self, seconds: f64)

Increment this epoch by the number of days provided.

pub fn mut_sub_days(&mut self, days: f64)

Decrement this epoch by the number of days provided.

pub fn mut_sub_secs(&mut self, seconds: f64)

Decrement this epoch by the number of days provided.

Trait Implementations

impl Clone for Epoch

fn clone(&self) -> Epoch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Epoch

impl PartialEq<Epoch> for Epoch

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

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

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

This method tests for !=.

impl PartialOrd<Epoch> for Epoch

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

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

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

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

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

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

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

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

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

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

impl Debug for Epoch

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

Formats the value using the given formatter.

impl Sub<Epoch> for Epoch

type Output = f64

The resulting type after applying the - operator.

fn sub(self, other: Self) -> f64

Performs the - operation.

impl Sub<f64> for Epoch

type Output = Self

The resulting type after applying the - operator.

fn sub(self, seconds: f64) -> Self

Performs the - operation.

impl Add<f64> for Epoch

type Output = Self

The resulting type after applying the + operator.

fn add(self, seconds: f64) -> Self

Performs the + operation.

impl StructuralPartialEq for Epoch