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

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

/// Monitors for stale/missing data by checking if updates arrive within a timeout.
#[derive(Debug, Clone, Copy)]
pub struct TimeoutMonitor<S: ControlScalar> {
    timeout: S,
    elapsed: S,
    in_violation: bool,
}

impl<S: ControlScalar> TimeoutMonitor<S> {
    pub fn new(timeout: S) -> Self {
        Self {
            timeout,
            elapsed: S::ZERO,
            in_violation: false,
        }
    }

    /// Call this when new data arrives (resets the timer).
    pub fn feed(&mut self) {
        self.elapsed = S::ZERO;
        self.in_violation = false;
    }

    /// Advance time. Returns true if within timeout, false if timed out.
    pub fn check(&mut self, dt: S) -> bool {
        self.elapsed += dt;
        if self.elapsed >= self.timeout {
            self.in_violation = true;
            false
        } else {
            true
        }
    }

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

    pub fn reset(&mut self) {
        self.elapsed = S::ZERO;
        self.in_violation = false;
    }
}

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

    #[test]
    fn no_timeout_when_fed() {
        let mut m = TimeoutMonitor::<f64>::new(0.1);
        assert!(m.check(0.05));
        m.feed();
        assert!(m.check(0.05));
        m.feed();
        assert!(m.check(0.05));
        assert!(!m.in_violation());
    }

    #[test]
    fn timeout_when_not_fed() {
        let mut m = TimeoutMonitor::<f64>::new(0.1);
        assert!(m.check(0.05));
        assert!(!m.check(0.06));
        assert!(m.in_violation());
    }

    #[test]
    fn feed_clears_violation() {
        let mut m = TimeoutMonitor::<f64>::new(0.1);
        m.check(0.2);
        assert!(m.in_violation());
        m.feed();
        assert!(!m.in_violation());
        assert!(m.check(0.05));
    }

    #[test]
    fn reset_clears() {
        let mut m = TimeoutMonitor::<f64>::new(0.1);
        m.check(0.2);
        m.reset();
        assert!(!m.in_violation());
    }
}