bo4e-core 0.1.1

Core types for BO4E (Business Objects for Energy)
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

//! Aggregated value (Aggregiertwert) component.

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};

use crate::enums::Unit;
use crate::traits::{Bo4eMeta, Bo4eObject};

/// An aggregated value computed from multiple source values.
///
/// German: Aggregiertwert
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::AggregatedValue;
/// use bo4e_core::enums::Unit;
/// use chrono::Utc;
///
/// let value = AggregatedValue {
///     timestamp: Some(Utc::now()),
///     value: Some(15000.0),
///     unit: Some(Unit::KilowattHour),
///     aggregation_method: Some("SUM".to_string()),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AggregatedValue {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Timestamp for the aggregated value (Zeitpunkt)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub timestamp: Option<DateTime<Utc>>,

    /// The aggregated value (Wert)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub value: Option<f64>,

    /// Unit of the value (Einheit)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub unit: Option<Unit>,

    /// Aggregation method (Aggregationsmethode)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub aggregation_method: Option<String>,

    /// Period start for aggregation (Periodenbeginn)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub period_start: Option<DateTime<Utc>>,

    /// Period end for aggregation (Periodenende)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub period_end: Option<DateTime<Utc>>,

    /// Number of source values aggregated (Anzahl Quellwerte)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub source_count: Option<i32>,

    /// OBIS code (OBIS-Kennzahl)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub obis_code: Option<String>,
}

impl Bo4eObject for AggregatedValue {
    fn type_name_german() -> &'static str {
        "Aggregiertwert"
    }

    fn type_name_english() -> &'static str {
        "AggregatedValue"
    }

    fn meta(&self) -> &Bo4eMeta {
        &self.meta
    }

    fn meta_mut(&mut self) -> &mut Bo4eMeta {
        &mut self.meta
    }
}

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

    #[test]
    fn test_aggregated_value() {
        let value = AggregatedValue {
            timestamp: Some(Utc.with_ymd_and_hms(2024, 1, 31, 23, 59, 59).unwrap()),
            value: Some(15000.0),
            unit: Some(Unit::KilowattHour),
            aggregation_method: Some("SUM".to_string()),
            source_count: Some(31),
            ..Default::default()
        };

        let json = serde_json::to_string(&value).unwrap();
        assert!(json.contains("15000"));
        assert!(json.contains("SUM"));
    }

    #[test]
    fn test_average_aggregation() {
        let start = Utc.with_ymd_and_hms(2024, 1, 1, 0, 0, 0).unwrap();
        let end = Utc.with_ymd_and_hms(2024, 1, 31, 23, 59, 59).unwrap();

        let value = AggregatedValue {
            value: Some(125.5),
            aggregation_method: Some("AVERAGE".to_string()),
            period_start: Some(start),
            period_end: Some(end),
            source_count: Some(2976),
            ..Default::default()
        };

        let json = serde_json::to_string(&value).unwrap();
        assert!(json.contains("AVERAGE"));
        assert!(json.contains("2976"));
    }

    #[test]
    fn test_roundtrip() {
        let value = AggregatedValue {
            timestamp: Some(Utc::now()),
            value: Some(999.99),
            aggregation_method: Some("MAX".to_string()),
            ..Default::default()
        };

        let json = serde_json::to_string(&value).unwrap();
        let parsed: AggregatedValue = serde_json::from_str(&json).unwrap();
        assert_eq!(value.value, parsed.value);
        assert_eq!(value.aggregation_method, parsed.aggregation_method);
    }

    #[test]
    fn test_bo4e_object_impl() {
        assert_eq!(AggregatedValue::type_name_german(), "Aggregiertwert");
        assert_eq!(AggregatedValue::type_name_english(), "AggregatedValue");
    }
}