phoxal 0.66.0

Phoxal - production-oriented autonomous robot framework: the one framework library, holding the runtime engine, the api contract tree, the typed bus, the canonical model, and the bundle.
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

crate::endpoints! {
    state: State<LocalizationState>;
}

fn finite(value: f64) -> bool {
    value.is_finite()
}

fn finite_f32(value: f32) -> bool {
    value.is_finite()
}

fn canonical_yaw(value: f64) -> bool {
    value.is_finite() && (-std::f64::consts::PI..=std::f64::consts::PI).contains(&value)
}

#[derive(
    phoxal_macros::DescribeWire, Clone, Debug, PartialEq, serde::Serialize, serde::Deserialize,
)]
#[serde(try_from = "LocalizationStateWire")]
pub struct LocalizationState {
    pub x_m: f64,
    pub y_m: f64,
    pub yaw_rad: f64,
    pub confidence: f32,
}

impl LocalizationState {
    pub fn try_new(
        x_m: f64,
        y_m: f64,
        yaw_rad: f64,
        confidence: f32,
    ) -> Result<Self, &'static str> {
        if !finite(x_m)
            || !finite(y_m)
            || !canonical_yaw(yaw_rad)
            || !finite_f32(confidence)
            || !(0.0..=1.0).contains(&confidence)
        {
            return Err("localization state must contain finite bounded values and canonical yaw");
        }
        Ok(Self {
            x_m,
            y_m,
            yaw_rad,
            confidence,
        })
    }
}

#[derive(Clone, Debug, serde::Deserialize)]
#[serde(deny_unknown_fields)]
struct LocalizationStateWire {
    x_m: f64,
    y_m: f64,
    yaw_rad: f64,
    confidence: f32,
}

impl TryFrom<LocalizationStateWire> for LocalizationState {
    type Error = &'static str;
    fn try_from(value: LocalizationStateWire) -> Result<Self, Self::Error> {
        Self::try_new(value.x_m, value.y_m, value.yaw_rad, value.confidence)
    }
}

impl LocalizationState {
    #[must_use]
    pub fn is_usable(&self) -> bool {
        self.x_m.is_finite()
            && self.y_m.is_finite()
            && self.yaw_rad.is_finite()
            && self.confidence.is_finite()
            && self.confidence > 0.0
    }
}