Skip to main content

Frame

Enum Frame 

Source
pub enum Frame {
    Icrf,
    J2000,
    Cirf,
    Tirf,
    Itrf,
    Iau(Origin),
    Mod(ReferenceSystem),
    Tod(ReferenceSystem),
    Pef(ReferenceSystem),
    Teme,
}
Expand description

A reference frame determined at runtime.

Covers the same set of frames as the zero-sized frame types, as a single closed enum. Because the frame is not known statically, frame properties are reached through the fallible checks (TryQuasiInertial, TryBodyFixed) rather than the marker traits.

Variants§

§

Icrf

International Celestial Reference Frame.

§

J2000

J2000 Mean Equator and Equinox.

§

Cirf

Celestial Intermediate Reference Frame.

§

Tirf

Terrestrial Intermediate Reference Frame.

§

Itrf

International Terrestrial Reference Frame.

§

Iau(Origin)

IAU body-fixed frame for the given origin.

§

Mod(ReferenceSystem)

Mean of Date frame for the given IERS convention.

§

Tod(ReferenceSystem)

True of Date frame for the given IERS convention.

§

Pef(ReferenceSystem)

Pseudo-Earth Fixed frame for the given IERS convention.

§

Teme

True Equator Mean Equinox.

Trait Implementations§

Source§

impl Clone for Frame

Source§

fn clone(&self) -> Frame

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Frame

Source§

impl Debug for Frame

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Frame

Source§

fn default() -> Frame

Returns the “default value” for a type. Read more
Source§

impl Eq for Frame

Source§

impl From<Cirf> for Frame

Source§

fn from(_: Cirf) -> Self

Converts to this type from the input type.
Source§

impl<T: TryRotationalElements + Copy + Into<Origin>> From<Iau<T>> for Frame

Source§

fn from(frame: Iau<T>) -> Self

Converts to this type from the input type.
Source§

impl From<Icrf> for Frame

Source§

fn from(_: Icrf) -> Self

Converts to this type from the input type.
Source§

impl From<Itrf> for Frame

Source§

fn from(_: Itrf) -> Self

Converts to this type from the input type.
Source§

impl From<J2000> for Frame

Source§

fn from(_: J2000) -> Self

Converts to this type from the input type.
Source§

impl<T: IersSystem + Into<ReferenceSystem>> From<Mod<T>> for Frame

Source§

fn from(frame: Mod<T>) -> Self

Converts to this type from the input type.
Source§

impl<T: IersSystem + Into<ReferenceSystem>> From<Pef<T>> for Frame

Source§

fn from(frame: Pef<T>) -> Self

Converts to this type from the input type.
Source§

impl From<Teme> for Frame

Source§

fn from(_: Teme) -> Self

Converts to this type from the input type.
Source§

impl From<Tirf> for Frame

Source§

fn from(_: Tirf) -> Self

Converts to this type from the input type.
Source§

impl<T: IersSystem + Into<ReferenceSystem>> From<Tod<T>> for Frame

Source§

fn from(frame: Tod<T>) -> Self

Converts to this type from the input type.
Source§

impl FromStr for Frame

Source§

type Err = UnknownFrameError

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl PartialEq for Frame

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl ReferenceFrame for Frame

Source§

fn name(&self) -> String

Returns the full name of the frame (e.g. “International Celestial Reference Frame”).
Source§

fn abbreviation(&self) -> String

Returns the abbreviated name (e.g. “ICRF”).
Source§

impl<T, P> RotateToIcrf<T, P> for Frame

Source§

type Error = RotationError

The error type returned when the rotation cannot be computed.
Source§

fn rotation_to_icrf( &self, provider: &P, time: Time<T>, ) -> Result<Rotation, Self::Error>

Returns the rotation from this frame to ICRF at time.
Source§

fn rotation_from_icrf( &self, provider: &P, time: Time<T>, ) -> Result<Rotation, Self::Error>

Returns the rotation from ICRF to this frame at time.
Source§

impl StructuralPartialEq for Frame

Source§

impl TryBodyFixed for Frame

Source§

type Origin = Origin

The coordinate origin (central body) of the body-fixed frame.
Source§

fn try_body_fixed(&self) -> Result<(), NonBodyFixedFrameError>

Returns Ok(()) if the frame is body-fixed.
Source§

fn try_origin(&self) -> Result<Self::Origin, NonBodyFixedFrameError>

Returns the coordinate origin (central body) of the body-fixed frame.
Source§

impl TryQuasiInertial for Frame

Source§

fn try_quasi_inertial(&self) -> Result<(), NonQuasiInertialFrameError>

Returns Ok(()) if the frame is quasi-inertial.
Source§

impl TryReferenceEllipsoid for Frame

Source§

fn try_reference_ellipsoid( &self, ) -> Result<Ellipsoid, UndefinedReferenceEllipsoidError>

Returns the reference ellipsoid conventionally paired with this frame, or an error if the frame is not body-fixed or its origin is not a spheroid.

Auto Trait Implementations§

§

impl Freeze for Frame

§

impl RefUnwindSafe for Frame

§

impl Send for Frame

§

impl Sync for Frame

§

impl Unpin for Frame

§

impl UnsafeUnpin for Frame

§

impl UnwindSafe for Frame

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T, O, Tg, P> TryRotation<O, Tg, T> for P

Source§

type Error = RotationError

The error type returned when the rotation cannot be computed.
Source§

fn try_rotation( &self, origin: O, target: Tg, time: Time<T>, ) -> Result<Rotation, <P as TryRotation<O, Tg, T>>::Error>

Computes the rotation from origin to target at the given time.