Create FrameUid to pass around a small thing

src/ephemerides/mod.rs

@@ -13,7 +13,7 @@ use snafu::prelude::*;
 
 use crate::{
     errors::PhysicsError, math::interpolation::InterpolationError, naif::daf::DAFError,
-    prelude::Frame, NaifId,
+    prelude::FrameUid, NaifId,
 };
 
 pub mod paths;
@@ -33,8 +33,8 @@ pub enum EphemerisError {
         "Could not translate from {from} to {to}: no common origin found at epoch {epoch}"
     ))]
     TranslationOrigin {
-        from: Frame,
-        to: Frame,
+        from: FrameUid,
+        to: FrameUid,
         epoch: Epoch,
     },
     #[snafu(display("no ephemeris data loaded (must call load_spk)"))]

src/ephemerides/paths.rs

@@ -148,8 +148,8 @@ impl<'a> Almanac<'a> {
         // path is which brings the non zero-length path back to the file root.
         if from_len == 0 && to_len == 0 {
             Err(EphemerisError::TranslationOrigin {
-                from: from_frame,
-                to: to_frame,
+                from: from_frame.into(),
+                to: to_frame.into(),
                 epoch,
             })
         } else if from_len != 0 && to_len == 0 {

src/errors.rs

@@ -11,7 +11,7 @@
 use hifitime::Epoch;
 use snafu::prelude::*;
 
-use crate::prelude::Frame;
+use crate::prelude::FrameUid;
 use crate::structure::semver::Semver;
 use crate::NaifId;
 use core::convert::From;
@@ -41,11 +41,6 @@ pub enum AniseError {
     NoInterpolationData,
     /// Raised to prevent overwriting an existing file
     FileExists,
-    /// Raised if a transformation is requested but the frames have no common origin
-    DisjointFrames {
-        from_frame: Frame,
-        to_frame: Frame,
-    },
     /// Raised if the ephemeris or orientation is deeper to the context origin than this library supports
     MaxTreeDepth,
     /// Raised if there is no interpolation data for the requested epoch, i.e. ephemeris/orientation starts after or ends before the requested epoch
@@ -107,7 +102,10 @@ pub enum IntegrityError {
     /// The lookup table is broken somehow
     LookupTable,
     /// Raised if a transformation is requested but the frames have no common origin
-    DisjointRoots { from_frame: Frame, to_frame: Frame },
+    DisjointRoots {
+        from_frame: FrameUid,
+        to_frame: FrameUid,
+    },
     #[snafu(display(
         "data for {variable} in {dataset} decoded as subnormal double (data malformed?)"
     ))]
@@ -145,8 +143,8 @@ pub enum PhysicsError {
     #[snafu(display("frames {frame1} and {frame2} differ while {action}"))]
     FrameMismatch {
         action: &'static str,
-        frame1: Frame,
-        frame2: Frame,
+        frame1: FrameUid,
+        frame2: FrameUid,
     },
     #[snafu(display("origins {from1} and {from2} differ while {action}"))]
     OriginMismatch {
@@ -160,7 +158,7 @@ pub enum PhysicsError {
     MissingFrameData {
         action: &'static str,
         data: &'static str,
-        frame: Frame,
+        frame: FrameUid,
     },
     #[snafu(display("parabolic orbits are physically impossible and the eccentricity calculated to be within {limit:e} of 1.0"))]
     ParabolicEccentricity { limit: f64 },
@@ -209,11 +207,6 @@ impl fmt::Display for AniseError {
                 f,
                 "ANISE error: operation aborted to prevent overwriting an existing file"
             ),
-            Self::DisjointFrames { from_frame: from, to_frame: to } => write!(
-                f,
-                "ANISE error: frame {} and {} do not share a common origin",
-                to, from
-            ),
             Self::MaxTreeDepth => write!(
                 f,
                 "ANISE error: the ephemeris or orientation is deeper to the context origin than this library supports"

src/frames/frame.rs

@@ -86,11 +86,11 @@ impl Frame {
 
     /// Returns the gravitational parameters of this frame, if defined
     pub fn mu_km3_s2(&self) -> Result<f64, PhysicsError> {
-        Ok(self.mu_km3_s2.ok_or(PhysicsError::MissingFrameData {
+        self.mu_km3_s2.ok_or(PhysicsError::MissingFrameData {
             action: "retrieving mean equatorial radius",
             data: "shape",
-            frame: *self,
-        })?)
+            frame: self.into(),
+        })
     }
 
     /// Returns the mean equatorial radius in km, if defined
@@ -100,7 +100,7 @@ impl Frame {
             .ok_or(PhysicsError::MissingFrameData {
                 action: "retrieving mean equatorial radius",
                 data: "shape",
-                frame: *self,
+                frame: self.into(),
             })?
             .mean_equatorial_radius_km())
     }
@@ -112,7 +112,7 @@ impl Frame {
             .ok_or(PhysicsError::MissingFrameData {
                 action: "retrieving semi major axis radius",
                 data: "shape",
-                frame: *self,
+                frame: self.into(),
             })?
             .semi_major_equatorial_radius_km)
     }
@@ -123,7 +123,7 @@ impl Frame {
             .ok_or(PhysicsError::MissingFrameData {
                 action: "retrieving flattening ratio",
                 data: "shape",
-                frame: *self,
+                frame: self.into(),
             })?
             .flattening())
     }

src/frames/mod.rs

@@ -8,5 +8,58 @@
  * Documentation: https://nyxspace.com/
  */
 
+use crate::{
+    constants::{
+        celestial_objects::celestial_name_from_id, orientations::orientation_name_from_id,
+    },
+    NaifId,
+};
+use core::fmt;
+
 pub mod frame;
 pub use frame::Frame;
+
+/// A unique frame reference that only contains enough information to build the actual Frame object.
+/// It cannot be used for any computations, is it be used in any structure apart from error structures.
+///
+/// # Usage note
+/// You should almost always prefer Frame over FrameRef unless you will
+#[derive(Copy, Clone, Debug, PartialEq, Eq)]
+pub struct FrameUid {
+    pub ephemeris_id: NaifId,
+    pub orientation_id: NaifId,
+}
+
+impl From<Frame> for FrameUid {
+    fn from(frame: Frame) -> Self {
+        Self {
+            ephemeris_id: frame.ephemeris_id,
+            orientation_id: frame.orientation_id,
+        }
+    }
+}
+
+impl From<&Frame> for FrameUid {
+    fn from(frame: &Frame) -> Self {
+        Self {
+            ephemeris_id: frame.ephemeris_id,
+            orientation_id: frame.orientation_id,
+        }
+    }
+}
+
+impl fmt::Display for FrameUid {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
+        let body_name = match celestial_name_from_id(self.ephemeris_id) {
+            Some(name) => name.to_string(),
+            None => format!("body {}", self.ephemeris_id),
+        };
+
+        let orientation_name = match orientation_name_from_id(self.orientation_id) {
+            Some(name) => name.to_string(),
+            None => format!("orientation {}", self.orientation_id),
+        };
+
+        write!(f, "{body_name} {orientation_name}")
+    }
+}

src/orientations/mod.rs

@@ -13,7 +13,7 @@ use snafu::prelude::*;
 
 use crate::{
     errors::PhysicsError, math::interpolation::InterpolationError, naif::daf::DAFError,
-    prelude::Frame,
+    prelude::FrameUid,
 };
 
 #[derive(Debug, Snafu)]
@@ -29,8 +29,8 @@ pub enum OrientationError {
         "Could not rotate from {from} to {to}: no common origin found at epoch {epoch}"
     ))]
     RotationOrigin {
-        from: Frame,
-        to: Frame,
+        from: FrameUid,
+        to: FrameUid,
         epoch: Epoch,
     },
     #[snafu(display("no oreitnation data loaded (must call load_bpc or DataSet::from_bytes)"))]