lox-space 0.1.0-alpha.48

The Lox toolbox for space mission analysis and design
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

// SPDX-FileCopyrightText: 2024 Helge Eichhorn <git@helgeeichhorn.de>
//
// SPDX-License-Identifier: MPL-2.0

use crate::time::time_scales::{DynTimeScale, TimeScale, UnknownTimeScaleError};
use pyo3::{
    Bound, PyAny, PyErr, PyResult, exceptions::PyValueError, pyclass, pymethods,
    types::PyAnyMethods,
};

/// Wrapper converting [`UnknownTimeScaleError`] into a Python `ValueError`.
pub struct PyUnknownTimeScaleError(pub UnknownTimeScaleError);

impl From<PyUnknownTimeScaleError> for PyErr {
    fn from(err: PyUnknownTimeScaleError) -> Self {
        PyValueError::new_err(err.0.to_string())
    }
}

/// Represents an astronomical time scale.
///
/// Supported time scales:
///
/// - **TAI**: International Atomic Time - the basis for civil time
/// - **TT**: Terrestrial Time - used for geocentric ephemerides
/// - **TDB**: Barycentric Dynamical Time - used for solar system ephemerides
/// - **TCB**: Barycentric Coordinate Time - relativistic coordinate time
/// - **TCG**: Geocentric Coordinate Time - relativistic coordinate time
/// - **UT1**: Universal Time - tied to Earth's rotation
///
/// Args:
///     abbreviation: Time scale abbreviation ("TAI", "TT", "TDB", "TCB", "TCG", "UT1").
///
/// Raises:
///     ValueError: If the abbreviation is not recognized.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
#[pyclass(name = "TimeScale", module = "lox_space", frozen, eq, from_py_object)]
pub struct PyTimeScale(pub DynTimeScale);

#[pymethods]
impl PyTimeScale {
    #[new]
    /// Constructs a `TimeScale` from its abbreviation string (e.g., `"TAI"`).
    pub fn new(abbreviation: &str) -> PyResult<Self> {
        Ok(PyTimeScale(
            abbreviation.parse().map_err(PyUnknownTimeScaleError)?,
        ))
    }
    fn __getnewargs__(&self) -> (String,) {
        (self.abbreviation(),)
    }

    /// Returns the developer representation of the `TimeScale`.
    pub fn __repr__(&self) -> String {
        format!("TimeScale(\"{}\")", self.0)
    }

    /// Returns the abbreviation string of the `TimeScale`.
    pub fn __str__(&self) -> String {
        format!("{}", self.0)
    }

    /// Return the time scale abbreviation (e.g., "TAI").
    pub fn abbreviation(&self) -> String {
        self.0.abbreviation().to_owned()
    }

    /// Return the full name of the time scale (e.g., "International Atomic Time").
    pub fn name(&self) -> String {
        self.0.name().to_owned()
    }
}

impl TryFrom<&Bound<'_, PyAny>> for PyTimeScale {
    type Error = PyErr;

    fn try_from(value: &Bound<'_, PyAny>) -> Result<Self, Self::Error> {
        if let Ok(name) = value.extract::<&str>() {
            return Ok(PyTimeScale(name.parse().map_err(PyUnknownTimeScaleError)?));
        } else if let Ok(scale) = value.extract::<PyTimeScale>() {
            return Ok(scale);
        }
        Err(PyValueError::new_err(
            "'scale' argument must either a string or a 'TimeScale' instance",
        ))
    }
}