Struct nyx_space::md::prelude::Frame

pub struct Frame {
    pub ephemeris_id: i32,
    pub orientation_id: i32,
    pub mu_km3_s2: Option<f64>,
    pub shape: Option<Ellipsoid>,
}

A Frame uniquely defined by its ephemeris center and orientation. Refer to FrameDetail for frames combined with parameters.

Fields

ephemeris_id: i32

orientation_id: i32

mu_km3_s2: Option<f64>

Gravity parameter of this frame, only defined on celestial frames

shape: Option<Ellipsoid>

Shape of the geoid of this frame, only defined on geodetic frames

Implementations

impl Frame

pub const fn new(ephemeris_id: i32, orientation_id: i32) -> Frame

Constructs a new frame given its ephemeris and orientations IDs, without defining anything else (so this is not a valid celestial frame, although the data could be populated later).

pub const fn from_ephem_j2000(ephemeris_id: i32) -> Frame

pub const fn from_orient_ssb(orientation_id: i32) -> Frame

pub fn from_name(center: &str, ref_frame: &str) -> Result<Frame, AlmanacError>

Attempts to create a new frame from its center and reference frame name. This function is compatible with the CCSDS OEM names.

impl Frame

pub const fn with_ephem(&self, new_ephem_id: i32) -> Frame

Returns a copy of this Frame whose ephemeris ID is set to the provided ID

pub const fn with_orient(&self, new_orient_id: i32) -> Frame

Returns a copy of this Frame whose orientation ID is set to the provided ID

pub const fn is_celestial(&self) -> bool

Returns whether this is a celestial frame

pub const fn is_geodetic(&self) -> bool

Returns whether this is a geodetic frame

pub const fn ephem_origin_id_match(&self, other_id: i32) -> bool

Returns true if the ephemeris origin is equal to the provided ID

pub const fn orient_origin_id_match(&self, other_id: i32) -> bool

Returns true if the orientation origin is equal to the provided ID

pub const fn ephem_origin_match(&self, other: Frame) -> bool

Returns true if the ephemeris origin is equal to the provided frame

pub const fn orient_origin_match(&self, other: Frame) -> bool

Returns true if the orientation origin is equal to the provided frame

pub fn mu_km3_s2(&self) -> Result<f64, PhysicsError>

Returns the gravitational parameters of this frame, if defined

pub fn with_mu_km3_s2(&self, mu_km3_s2: f64) -> Frame

Returns a copy of this frame with the graviational parameter set to the new value.

pub fn mean_equatorial_radius_km(&self) -> Result<f64, PhysicsError>

Returns the mean equatorial radius in km, if defined

pub fn semi_major_radius_km(&self) -> Result<f64, PhysicsError>

Returns the semi major radius of the tri-axial ellipoid shape of this frame, if defined

pub fn flattening(&self) -> Result<f64, PhysicsError>

Returns the flattening ratio (unitless)

pub fn polar_radius_km(&self) -> Result<f64, PhysicsError>

Returns the polar radius in km, if defined

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Frame

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Frame

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

Formats the value using the given formatter.

impl From<&Frame> for FrameUid

fn from(frame: &Frame) -> FrameUid

Converts to this type from the input type.

impl From<&FrameUid> for Frame

fn from(uid: &FrameUid) -> Frame

Converts to this type from the input type.

impl From<Frame> for FrameUid

fn from(frame: Frame) -> FrameUid

Converts to this type from the input type.

impl From<FrameUid> for Frame

fn from(uid: FrameUid) -> Frame

Converts to this type from the input type.

impl LowerExp for Frame

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

Only prints the ephemeris name

impl LowerHex for Frame

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

Only prints the UID

impl Octal for Frame

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

Only prints the orientation name

impl PartialEq for Frame

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

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 StaticType for Frame

where i32: StaticType, Option<f64>: StaticType, Option<Ellipsoid>: StaticType,

fn static_type() -> SimpleType

Return the Dhall type that represents this type.

impl Copy for Frame

impl StructuralPartialEq for Frame