Access metadata: load properties and expose them

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "liblrs"
-version = "0.2.3"
+version = "0.2.4"
 edition = "2021"
 description = "Library to manipulate linear referencing systems"
 license = "MIT"

python/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "liblrs_python"
 description = "Python bindings for liblrs: a library to work with linear referencing systems"
-version = "0.2.3"
+version = "0.2.4"
 edition = "2021"
 license = "MIT"
 repository = "https://github.com/OpenRailAssociation/liblrs/"

python/liblrs_python.pyi

@@ -218,6 +218,24 @@ class Lrs:
         """
         ...
 
+    def lrs_properties(self) -> dict[str, str]:
+        r"""
+        [`Properties`] of the lrs
+        """
+        ...
+
+    def lrm_properties(self, lrm_index:int) -> dict[str, str]:
+        r"""
+        [`Properties`] for a given lrm
+        """
+        ...
+
+    def anchor_properties(self, lrm_index:int, anchor_index:int) -> dict[str, str]:
+        r"""
+        [`Properties`] for a given anchor
+        """
+        ...
+
 
 class Point:
     r"""

python/src/lib.rs

@@ -4,8 +4,8 @@
 use std::path::PathBuf;
 
 use liblrs::lrs::LrmHandle;
+use liblrs::lrs::{LrsBase, Properties};
 use liblrs::lrs_ext::*;
-use liblrs::{builder::Properties, lrs::LrsBase};
 use pyo3::{exceptions::PyTypeError, prelude::*};
 
 /// Holds the whole Linear Referencing System.
@@ -341,6 +341,21 @@ impl Lrs {
             })
             .collect()
     }
+
+    /// [`Properties`] of the lrs
+    pub fn lrs_properties(&self) -> Properties {
+        self.lrs.lrs_properties().clone()
+    }
+
+    /// [`Properties`] for a given lrm
+    pub fn lrm_properties(&self, lrm_index: usize) -> Properties {
+        self.lrs.lrm_properties(lrm_index).clone()
+    }
+
+    /// [`Properties`] for a given anchor
+    pub fn anchor_properties(&self, lrm_index: usize, anchor_index: usize) -> Properties {
+        self.lrs.anchor_properties(lrm_index, anchor_index).clone()
+    }
 }
 
 #[pyclass]

src/builder.rs

@@ -9,21 +9,11 @@ use geo::{Coord, Distance};
 
 use crate::curves::{Curve, CurveError, CurveProjection, SphericalLineStringCurve};
 
+use crate::lrs::Properties;
 use crate::lrs_ext::ExtLrs;
 use crate::lrs_generated::{self, *};
 use crate::osm_helpers::sort_edges;
-
-/// A key-value `HashMap` to add metadata to the objects.
-pub type Properties = std::collections::HashMap<String, String>;
-
-#[macro_export]
-/// Build a properties map:
-/// `properties!("source" => "openstreetmap", "license" => "ODbL")`.
-macro_rules! properties {
-    ($($k:expr => $v:expr),* $(,)?) => {{
-        core::convert::From::from([$(($k.to_owned(), $v.to_owned()),)*])
-    }};
-}
+use crate::properties;
 
 /// The linear position of an [`Anchor`] doesn’t always match the measured distance.
 /// For example if a road was transformed into a bypass, resulting in a longer road,
@@ -656,4 +646,20 @@ mod tests {
         assert_relative_eq!(lrm.x(), 0.);
         assert_relative_eq!(lrm.y(), 0.);
     }
+
+    #[test]
+    fn properties() {
+        let mut b = Builder::new();
+        let traversal = build_traversal(&mut b);
+        b.add_lrm(
+            "lrm",
+            traversal,
+            &[],
+            properties!("test_key" => "test_value"),
+        );
+        let lrs = b.build_lrs(properties!()).unwrap();
+
+        let p = lrs.lrm_properties(0);
+        assert_eq!(p["test_key"], "test_value")
+    }
 }

src/lrm_scale.rs

@@ -4,6 +4,8 @@
 use geo::Point;
 use thiserror::Error;
 
+use crate::lrs::Properties;
+
 /// Measurement along the `Curve`. Typically in meters.
 pub type CurvePosition = f64;
 
@@ -44,6 +46,9 @@ pub struct Anchor {
 
     /// Position of the anchor on the `Curve`.
     pub point: Option<Point>,
+
+    /// Metadata to describe the node
+    pub properties: Properties,
 }
 
 impl Anchor {
@@ -53,12 +58,14 @@ impl Anchor {
         scale_position: ScalePosition,
         curve_position: CurvePosition,
         point: Option<Point>,
+        properties: Properties,
     ) -> Self {
         Self {
             id: Some(name.to_owned()),
             scale_position,
             curve_position,
             point,
+            properties,
         }
     }
 
@@ -67,12 +74,14 @@ impl Anchor {
         scale_position: ScalePosition,
         curve_position: CurvePosition,
         point: Option<Point>,
+        properties: Properties,
     ) -> Self {
         Self {
             id: None,
             scale_position,
             curve_position,
             point,
+            properties,
         }
     }
 
@@ -258,14 +267,16 @@ impl LrmScale {
 pub(crate) mod tests {
     use geo::point;
 
+    use crate::properties;
+
     use super::*;
 
     pub(crate) fn scale() -> LrmScale {
         LrmScale {
             id: "id".to_owned(),
             anchors: vec![
-                Anchor::new("a", 0., 0., Some(point! { x: 0., y: 0. })),
-                Anchor::new("b", 10., 0.5, Some(point! { x: 0., y: 0. })),
+                Anchor::new("a", 0., 0., Some(point! { x: 0., y: 0. }), properties!()),
+                Anchor::new("b", 10., 0.5, Some(point! { x: 0., y: 0. }), properties!()),
             ],
         }
     }
@@ -300,8 +311,8 @@ pub(crate) mod tests {
         let scale = LrmScale {
             id: "id".to_owned(),
             anchors: vec![
-                Anchor::new("a", 0., 2., Some(point! { x: 0., y: 0. })),
-                Anchor::new("b", 10., 3., Some(point! { x: 0., y: 0. })),
+                Anchor::new("a", 0., 2., Some(point! { x: 0., y: 0. }), properties!()),
+                Anchor::new("b", 10., 3., Some(point! { x: 0., y: 0. }), properties!()),
             ],
         };
 
@@ -332,10 +343,10 @@ pub(crate) mod tests {
         let scale = LrmScale {
             id: "id".to_owned(),
             anchors: vec![
-                Anchor::new_unnamed(0., 100., Some(point! { x: 0., y: 0. })),
-                Anchor::new("a", 1., 200., Some(point! { x: 0., y: 0. })),
-                Anchor::new("b", 3., 300., Some(point! { x: 0., y: 0. })),
-                Anchor::new_unnamed(4., 400., Some(point! { x: 0., y: 0. })),
+                Anchor::new_unnamed(0., 100., Some(point! { x: 0., y: 0. }), properties!()),
+                Anchor::new("a", 1., 200., Some(point! { x: 0., y: 0. }), properties!()),
+                Anchor::new("b", 3., 300., Some(point! { x: 0., y: 0. }), properties!()),
+                Anchor::new_unnamed(4., 400., Some(point! { x: 0., y: 0. }), properties!()),
             ],
         };
 
@@ -403,8 +414,8 @@ pub(crate) mod tests {
         let scale = LrmScale {
             id: "id".to_owned(),
             anchors: vec![
-                Anchor::new("a", 1000. + 0., -2., None),
-                Anchor::new_unnamed(1000. + 300., 1., None),
+                Anchor::new("a", 1000. + 0., -2., None, properties!()),
+                Anchor::new_unnamed(1000. + 300., 1., None, properties!()),
             ],
         };
 
@@ -426,9 +437,9 @@ pub(crate) mod tests {
         let scale = LrmScale {
             id: "id".to_owned(),
             anchors: vec![
-                Anchor::new("a", 0., 0., None),
-                Anchor::new_unnamed(1., 0.4, None),
-                Anchor::new_unnamed(9., 0.6, None),
+                Anchor::new("a", 0., 0., None, properties!()),
+                Anchor::new_unnamed(1., 0.4, None, properties!()),
+                Anchor::new_unnamed(9., 0.6, None, properties!()),
             ],
         };