bo4e_core/bo/
metering_price_sheet.rs

1//! Metering price sheet (PreisblattMessung) business object.
2
3use chrono::{DateTime, Utc};
4use serde::{Deserialize, Serialize};
5
6use crate::com::{Price, PricePosition, TimePeriod};
7use crate::enums::{Division, MeterType};
8use crate::traits::{Bo4eMeta, Bo4eObject};
9
10/// A price sheet for metering services.
11///
12/// German: PreisblattMessung
13///
14/// # Example
15///
16/// ```rust
17/// use bo4e_core::bo::MeteringPriceSheet;
18/// use bo4e_core::enums::Division;
19///
20/// let price_sheet = MeteringPriceSheet {
21///     designation: Some("Messpreisblatt 2024".to_string()),
22///     division: Some(Division::Electricity),
23///     ..Default::default()
24/// };
25/// ```
26#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
27#[serde(rename_all = "camelCase")]
28pub struct MeteringPriceSheet {
29    /// BO4E metadata
30    #[serde(flatten)]
31    pub meta: Bo4eMeta,
32
33    /// Name/designation of the price sheet (Bezeichnung)
34    #[serde(skip_serializing_if = "Option::is_none")]
35    pub designation: Option<String>,
36
37    /// Description (Beschreibung)
38    #[serde(skip_serializing_if = "Option::is_none")]
39    pub description: Option<String>,
40
41    /// Energy division (Sparte)
42    #[serde(skip_serializing_if = "Option::is_none")]
43    pub division: Option<Division>,
44
45    /// Type of meter this applies to (Zaehlerart)
46    #[serde(skip_serializing_if = "Option::is_none")]
47    pub meter_type: Option<MeterType>,
48
49    /// Price sheet number/identifier (Preisblattnummer)
50    #[serde(skip_serializing_if = "Option::is_none")]
51    pub price_sheet_number: Option<String>,
52
53    /// Validity period (Gueltigkeitszeitraum)
54    #[serde(skip_serializing_if = "Option::is_none")]
55    pub validity_period: Option<TimePeriod>,
56
57    /// Valid from date (Gueltig ab)
58    #[serde(skip_serializing_if = "Option::is_none")]
59    pub valid_from: Option<DateTime<Utc>>,
60
61    /// Valid until date (Gueltig bis)
62    #[serde(skip_serializing_if = "Option::is_none")]
63    pub valid_until: Option<DateTime<Utc>>,
64
65    /// Metering point operation price (Messstellenbetrieb)
66    #[serde(skip_serializing_if = "Option::is_none")]
67    pub metering_point_operation_price: Option<Price>,
68
69    /// Meter reading price (Ablesepreis)
70    #[serde(skip_serializing_if = "Option::is_none")]
71    pub reading_price: Option<Price>,
72
73    /// Price positions (Preispositionen)
74    #[serde(default, skip_serializing_if = "Vec::is_empty")]
75    pub positions: Vec<PricePosition>,
76
77    /// Metering operator
78    #[serde(skip_serializing_if = "Option::is_none")]
79    pub operator: Option<Box<super::BusinessPartner>>,
80}
81
82impl Bo4eObject for MeteringPriceSheet {
83    fn type_name_german() -> &'static str {
84        "PreisblattMessung"
85    }
86
87    fn type_name_english() -> &'static str {
88        "MeteringPriceSheet"
89    }
90
91    fn meta(&self) -> &Bo4eMeta {
92        &self.meta
93    }
94
95    fn meta_mut(&mut self) -> &mut Bo4eMeta {
96        &mut self.meta
97    }
98}
99
100#[cfg(test)]
101mod tests {
102    use super::*;
103
104    #[test]
105    fn test_metering_price_sheet_creation() {
106        let price_sheet = MeteringPriceSheet {
107            designation: Some("Messpreisblatt 2024".to_string()),
108            division: Some(Division::Electricity),
109            meter_type: Some(MeterType::ElectronicMeter),
110            price_sheet_number: Some("MP-2024-001".to_string()),
111            ..Default::default()
112        };
113
114        assert_eq!(price_sheet.meter_type, Some(MeterType::ElectronicMeter));
115    }
116
117    #[test]
118    fn test_serialize() {
119        let price_sheet = MeteringPriceSheet {
120            meta: Bo4eMeta::with_type("PreisblattMessung"),
121            designation: Some("Metering Prices".to_string()),
122            ..Default::default()
123        };
124
125        let json = serde_json::to_string(&price_sheet).unwrap();
126        assert!(json.contains(r#""designation":"Metering Prices""#));
127        assert!(json.contains(r#""_typ":"PreisblattMessung""#));
128    }
129
130    #[test]
131    fn test_roundtrip() {
132        let price_sheet = MeteringPriceSheet {
133            meta: Bo4eMeta::with_type("PreisblattMessung"),
134            designation: Some("Gas Metering".to_string()),
135            description: Some("Gas metering service prices".to_string()),
136            division: Some(Division::Gas),
137            price_sheet_number: Some("GM-2024".to_string()),
138            ..Default::default()
139        };
140
141        let json = serde_json::to_string(&price_sheet).unwrap();
142        let parsed: MeteringPriceSheet = serde_json::from_str(&json).unwrap();
143        assert_eq!(price_sheet, parsed);
144    }
145
146    #[test]
147    fn test_bo4e_object_impl() {
148        assert_eq!(MeteringPriceSheet::type_name_german(), "PreisblattMessung");
149        assert_eq!(
150            MeteringPriceSheet::type_name_english(),
151            "MeteringPriceSheet"
152        );
153    }
154}