oxictl 0.1.1

Pure Rust Real-Time Control Systems Framework
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
88
89

use crate::core::scalar::ControlScalar;

/// Monitors whether a value stays within acceptable bounds.
#[derive(Debug, Clone, Copy)]
pub struct RangeMonitor<S: ControlScalar> {
    low: S,
    high: S,
    in_violation: bool,
}

impl<S: ControlScalar> RangeMonitor<S> {
    pub fn new(low: S, high: S) -> Self {
        debug_assert!(low <= high);
        Self {
            low,
            high,
            in_violation: false,
        }
    }

    /// Check a value. Returns true if within range, false if violation.
    pub fn check(&mut self, value: S) -> bool {
        if value < self.low || value > self.high {
            self.in_violation = true;
            false
        } else {
            self.in_violation = false;
            true
        }
    }

    pub fn in_violation(&self) -> bool {
        self.in_violation
    }

    pub fn reset(&mut self) {
        self.in_violation = false;
    }

    pub fn low(&self) -> S {
        self.low
    }

    pub fn high(&self) -> S {
        self.high
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn within_range() {
        let mut m = RangeMonitor::<f64>::new(0.0, 100.0);
        assert!(m.check(50.0));
        assert!(!m.in_violation());
    }

    #[test]
    fn above_range() {
        let mut m = RangeMonitor::<f64>::new(0.0, 100.0);
        assert!(!m.check(101.0));
        assert!(m.in_violation());
    }

    #[test]
    fn below_range() {
        let mut m = RangeMonitor::<f64>::new(0.0, 100.0);
        assert!(!m.check(-1.0));
        assert!(m.in_violation());
    }

    #[test]
    fn boundary_values() {
        let mut m = RangeMonitor::<f64>::new(0.0, 100.0);
        assert!(m.check(0.0));
        assert!(m.check(100.0));
    }

    #[test]
    fn violation_clears_when_back_in_range() {
        let mut m = RangeMonitor::<f64>::new(0.0, 100.0);
        m.check(200.0);
        assert!(m.in_violation());
        m.check(50.0);
        assert!(!m.in_violation());
    }
}