feat(lox-frames): add frame ID to builtin frames

WIP

Author: helgee

crates/lox-frames/src/dynamic.rs

@@ -14,7 +14,7 @@ use crate::{
     providers::DefaultTransformProvider,
     traits::{
         NonBodyFixedFrameError, NonQuasiInertialFrameError, ReferenceFrame, TryBodyFixed,
-        TryQuasiInertial,
+        TryQuasiInertial, frame_id,
     },
     transformations::{Rotation, TryTransform},
 };
@@ -65,6 +65,16 @@ impl ReferenceFrame for DynFrame {
             DynFrame::Tirf | DynFrame::Itrf | DynFrame::Iau(_) => true,
         }
     }
+
+    fn frame_id(&self, _: crate::traits::private::Internal) -> Option<i32> {
+        match self {
+            DynFrame::Icrf => frame_id(Icrf),
+            DynFrame::Cirf => frame_id(Cirf),
+            DynFrame::Tirf => frame_id(Tirf),
+            DynFrame::Itrf => frame_id(Itrf),
+            DynFrame::Iau(dyn_origin) => Some(1000 + dyn_origin.id().0),
+        }
+    }
 }
 
 impl TryQuasiInertial for DynFrame {
@@ -168,7 +178,7 @@ mod tests {
     use super::*;
 
     use glam::DVec3;
-    use lox_bodies::DynOrigin;
+    use lox_bodies::{DynOrigin, Earth};
     use lox_test_utils::assert_approx_eq;
     use lox_time::utc::Utc;
     use rstest::rstest;
@@ -223,4 +233,16 @@ mod tests {
         assert_approx_eq!(r_act, r_exp, rtol <= 1e-8);
         assert_approx_eq!(v_act, v_exp, rtol <= 1e-5);
     }
+
+    #[test]
+    fn test_frame_id() {
+        assert_eq!(frame_id(Icrf), frame_id(DynFrame::Icrf));
+        assert_eq!(frame_id(Cirf), frame_id(DynFrame::Cirf));
+        assert_eq!(frame_id(Tirf), frame_id(DynFrame::Tirf));
+        assert_eq!(frame_id(Itrf), frame_id(DynFrame::Itrf));
+        assert_eq!(
+            frame_id(Iau::new(Earth)),
+            frame_id(DynFrame::Iau(DynOrigin::Earth))
+        );
+    }
 }

crates/lox-frames/src/frames.rs

@@ -2,7 +2,7 @@
 //
 // SPDX-License-Identifier: MPL-2.0
 
-use lox_bodies::{RotationalElements, TryRotationalElements, UndefinedOriginPropertyError};
+use lox_bodies::{Origin, RotationalElements, TryRotationalElements, UndefinedOriginPropertyError};
 
 use crate::traits::{BodyFixed, QuasiInertial, ReferenceFrame};
 
@@ -21,6 +21,10 @@ impl ReferenceFrame for Icrf {
     fn is_rotating(&self) -> bool {
         false
     }
+
+    fn frame_id(&self, _: crate::traits::private::Internal) -> Option<i32> {
+        Some(0)
+    }
 }
 
 impl QuasiInertial for Icrf {}
@@ -40,6 +44,10 @@ impl ReferenceFrame for Cirf {
     fn is_rotating(&self) -> bool {
         false
     }
+
+    fn frame_id(&self, _: crate::traits::private::Internal) -> Option<i32> {
+        Some(1)
+    }
 }
 
 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
@@ -57,6 +65,10 @@ impl ReferenceFrame for Tirf {
     fn is_rotating(&self) -> bool {
         true
     }
+
+    fn frame_id(&self, _: crate::traits::private::Internal) -> Option<i32> {
+        Some(2)
+    }
 }
 
 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
@@ -74,6 +86,10 @@ impl ReferenceFrame for Itrf {
     fn is_rotating(&self) -> bool {
         true
     }
+
+    fn frame_id(&self, _: crate::traits::private::Internal) -> Option<i32> {
+        Some(3)
+    }
 }
 
 impl BodyFixed for Itrf {}
@@ -119,7 +135,7 @@ impl<T: TryRotationalElements> BodyFixed for Iau<T> {}
 
 impl<T> ReferenceFrame for Iau<T>
 where
-    T: TryRotationalElements,
+    T: TryRotationalElements + Origin,
 {
     fn name(&self) -> String {
         let body = self.0.name();
@@ -137,4 +153,8 @@ where
     fn is_rotating(&self) -> bool {
         true
     }
+
+    fn frame_id(&self, _: crate::traits::private::Internal) -> Option<i32> {
+        Some(1000 + self.0.id().0)
+    }
 }

crates/lox-frames/src/traits.rs

@@ -4,10 +4,22 @@
 
 use thiserror::Error;
 
+pub(crate) mod private {
+    pub struct Internal;
+}
+
 pub trait ReferenceFrame {
     fn name(&self) -> String;
     fn abbreviation(&self) -> String;
     fn is_rotating(&self) -> bool;
+    #[doc(hidden)]
+    fn frame_id(&self, _: private::Internal) -> Option<i32> {
+        None
+    }
+}
+
+pub fn frame_id(frame: impl ReferenceFrame) -> Option<i32> {
+    frame.frame_id(private::Internal)
 }
 
 pub trait QuasiInertial: ReferenceFrame {}