nexrad-decode 0.1.2

Decoding functions and models for NEXRAD weather radar data.
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
90
91
92
93

/// An RDA alarm message definition to be referenced by an RDA status data message.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Message {
    code: u16,
    state: Option<State>,
    alarm_type: Option<AlarmType>,
    device: Option<Device>,
    sample: Option<u8>,
    message: &'static str,
}

impl Message {
    pub(crate) fn new(
        code: u16,
        state: Option<State>,
        alarm_type: Option<AlarmType>,
        device: Option<Device>,
        sample: Option<u8>,
        message: &'static str,
    ) -> Self {
        Self {
            code,
            state,
            alarm_type,
            device,
            sample,
            message,
        }
    }

    /// The alarm code.
    pub fn code(&self) -> u16 {
        self.code
    }

    /// The status of the RDA as a result of the alarm.
    pub fn state(&self) -> Option<State> {
        self.state
    }

    /// The type of alarm.
    pub fn alarm_type(&self) -> Option<AlarmType> {
        self.alarm_type
    }

    /// The hardware device area where the alarm originated.
    pub fn device(&self) -> Option<Device> {
        self.device
    }

    /// The number of samples required to trigger the alarm.
    pub fn sample(&self) -> Option<u8> {
        self.sample
    }

    /// The alarm message.
    pub fn message(&self) -> &'static str {
        self.message
    }
}

/// The status of the RDA as a result of the alarm.
#[derive(Debug, PartialEq, Eq, Clone, Copy, Hash)]
pub enum State {
    MaintenanceMandatory,
    MaintenanceRequired,
    Inoperative,
    /// Alarm not specifically tied to state change.
    Secondary,
}

/// The different classifications of alarms.
#[derive(Debug, PartialEq, Eq, Clone, Copy, Hash)]
pub enum AlarmType {
    /// Alarm failed consecutively enough times to meet the alarm reporting count/sample threshold.
    EdgeDetected,
    /// Alarm reported each time the condition is met.
    Occurrence,
    /// Alarm reported at most once every 15 minutes when the condition is met.
    FilteredOccurrence,
}

/// The hardware device area where the alarm originated.
#[derive(Debug, PartialEq, Eq, Clone, Copy, Hash)]
pub enum Device {
    Control,
    Pedestal,
    Receiver,
    SignalProcessor,
    Communications,
    TowerUtilities,
    Transmitter,
}