gnss-rs 2.6.0

GNSS constellations
Documentation
use thiserror::Error;

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

#[cfg(feature = "python")]
mod python;

#[cfg(feature = "python")]
use pyo3::prelude::pyclass;

/// DOMES parsing error
#[derive(Debug, Error)]
pub enum Error {
    #[error("invalid domes format")]
    InvalidFormat,

    #[error("invalid domes length")]
    InvalidLength,
}

/// DOMES site reference point.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
#[cfg_attr(feature = "python", pyclass)]
#[cfg_attr(feature = "python", pyo3(module = "gnss"))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum TrackingPoint {
    /// Monument (pole, pillar, geodetic marker..)
    Monument,

    /// Instrument reference point.
    /// This is usually the antenna reference point, but it can be any
    /// location referred to an instrument, like a specific location
    /// on one axis of a telescope.
    Instrument,
}

/// DOMES site identification number,
/// see <https://itrf.ign.fr/en/network/domes/description>.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[cfg_attr(feature = "python", pyclass)]
#[cfg_attr(feature = "python", pyo3(module = "gnss"))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct DOMES {
    /// Area / Country code (3 digits)
    pub area: u16,

    /// Area site number (2 digits)
    pub site: u8,

    /// Tracking point
    pub point: TrackingPoint,

    /// Sequential number (3 digits)
    pub sequential: u16,
}

impl core::fmt::LowerHex for TrackingPoint {
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        match self {
            TrackingPoint::Monument => write!(f, "M"),
            TrackingPoint::Instrument => write!(f, "S"),
        }
    }
}

impl core::fmt::Display for TrackingPoint {
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        match self {
            TrackingPoint::Monument => write!(f, "Monument"),
            TrackingPoint::Instrument => write!(f, "Instrument"),
        }
    }
}

impl core::str::FromStr for DOMES {
    type Err = Error;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        if s.len() == 9 {
            let point = if s[5..6].eq("M") {
                TrackingPoint::Monument
            } else if s[5..6].eq("S") {
                TrackingPoint::Instrument
            } else {
                return Err(Error::InvalidFormat);
            };
            let area = s[..3].parse::<u16>().map_err(|_| Error::InvalidFormat)?;
            let site = s[3..5].parse::<u8>().map_err(|_| Error::InvalidFormat)?;
            let sequential = s[6..].parse::<u16>().map_err(|_| Error::InvalidFormat)?;
            Ok(Self {
                point,
                area,
                site,
                sequential,
            })
        } else {
            Err(Error::InvalidLength)
        }
    }
}

impl core::fmt::Display for DOMES {
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        write!(
            f,
            "{:03}{:02}{:x}{:03}",
            self.area, self.site, self.point, self.sequential
        )
    }
}

#[cfg(test)]
mod test {
    use super::{TrackingPoint, DOMES};
    use std::str::FromStr;
    #[test]
    fn parser() {
        for (descriptor, expected) in [
            (
                "10002M006",
                DOMES {
                    area: 100,
                    site: 2,
                    sequential: 6,
                    point: TrackingPoint::Monument,
                },
            ),
            (
                "40405S031",
                DOMES {
                    area: 404,
                    site: 5,
                    sequential: 31,
                    point: TrackingPoint::Instrument,
                },
            ),
        ] {
            let domes = DOMES::from_str(descriptor).unwrap();
            assert_eq!(domes, expected, "failed to parse DOMES");
            // reciprocal
            assert_eq!(domes.to_string(), descriptor, "DOMES reciprocal failed");
        }
    }
}