Enum TimeScale 

#[non_exhaustive]
pub enum TimeScale {
    TAI,
    TT,
    ET,
    TDB,
    UTC,
    GPST,
    GST,
    BDT,
    QZSST,
    TCG,
    TCB,
    TL,
    TCL,
}

Enum of the different time systems available

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

TAI

TAI is the representation of an Epoch internally

TT

Terrestrial Time (TT) (previously called Terrestrial Dynamical Time (TDT))

ET

Ephemeris Time as defined by SPICE (slightly different from true TDB)

TDB

Dynamic Barycentric Time (TDB) (higher fidelity SPICE ephemeris time)

UTC

Universal Coordinated Time

GPST

GPS Time scale whose reference epoch is UTC midnight between 05 January and 06 January 1980; cf. https://gssc.esa.int/navipedia/index.php/Time_References_in_GNSS#GPS_Time_.28GPST.29. |UTC - TAI| = 19 Leap Seconds on that day.

GST

Galileo Time scale

BDT

BeiDou Time scale

QZSST

QZSS Time scale has the same properties as GPST but with dedicated clocks

TCG

Geocentric Coordinate Time

TCB

Barycentric Coordinate Time

TL

Experimental Lunar Time, option (iii) from the Lunar Reference Timescale paper, A Bourgoin*, P Defraigne and F Meynadier

TL is defined as a linear scaling of TCL such that TL has no secular drift with respect to TT. Since this implementation omits the bounded periodic TCL-TT terms, TL is equivalent to TT after the common 1977 reference epoch.

TCL

Experimental mean Lunar Coordinate Time of Lunar reference timescale, A Bourgoin*, P Defraigne and F Meynadier

This is not a full IAU-quality TCL realization. It models only the conventional secular mean rate between TCL and TT:

    d(TCL - TT) / dTT ≈ 6.8e-10

The bounded periodic TCL-TT terms and ephemeris-dependent relativistic integral are intentionally omitted

Implementations

impl TimeScale

pub const fn is_gnss(&self) -> bool

Returns true if Self is based off a GNSS constellation

pub const fn reference_epoch(self) -> Epoch

Returns this time scale’s reference epoch: Time Scale initialization date, expressed as an Epoch in TAI

impl TimeScale

pub const fn uses_leap_seconds(&self) -> bool

Returns true if self takes leap seconds into account :rtype: bool

Trait Implementations

impl Clone for TimeScale

fn clone(&self) -> TimeScale

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimeScale

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

Formats the value using the given formatter.

impl Default for TimeScale

fn default() -> TimeScale

Builds default TAI time scale

impl<'de> Deserialize<'de> for TimeScale

fn deserialize<__D>( __deserializer: __D, ) -> Result<TimeScale, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TimeScale

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

Prints given TimeScale

impl From<u8> for TimeScale

Allows conversion of a u8 into a TimeSystem. Mapping: 1: TT; 2: ET; 3: TDB; 4: UTC; 5: GPST; 6: GST; 7: BDT; 8: QZSST; 9: TCG; 10: TCB; anything else: TAI

fn from(val: u8) -> TimeScale

Converts to this type from the input type.

impl FromStr for TimeScale

type Err = ParsingError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<TimeScale, <TimeScale as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for TimeScale

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'py> IntoPyObject<'py> for TimeScale

type Target = TimeScale

The Python output type

type Output = Bound<'py, <TimeScale as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<TimeScale as IntoPyObject<'py>>::Output, <TimeScale as IntoPyObject<'py>>::Error>

Performs the conversion.

impl LowerHex for TimeScale

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

Prints given TimeScale in RINEX format ie., standard GNSS constellation name is preferred when possible

impl Ord for TimeScale

fn cmp(&self, other: &TimeScale) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TimeScale

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PyClass for TimeScale

const NAME: &'static str = "TimeScale"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyTypeInfo for TimeScale

const NAME: &'static str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&'static str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for TimeScale

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for TimeScale

impl Eq for TimeScale

impl StructuralPartialEq for TimeScale