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

//! Tariff calculation parameter (Tarifberechnungsparameter) component.

use serde::{Deserialize, Serialize};

use crate::enums::{TariffCalculationMethod, TariffTime};
use crate::traits::{Bo4eMeta, Bo4eObject};

/// Parameters for tariff calculation.
///
/// German: Tarifberechnungsparameter
///
/// # Example
///
/// ```rust
/// use bo4e_core::com::TariffCalculationParameter;
/// use bo4e_core::enums::TariffCalculationMethod;
///
/// let param = TariffCalculationParameter {
///     calculation_method: Some(TariffCalculationMethod::Tiers),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TariffCalculationParameter {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Method for tariff calculation (Berechnungsmethode)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub calculation_method: Option<TariffCalculationMethod>,

    /// Tariff time (day/night, etc.) (Tarifzeit)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tariff_time: Option<TariffTime>,

    /// Whether this applies to peak demand (Ist Leistungsabhängig)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub is_demand_based: Option<bool>,

    /// Minimum annual consumption for this tariff (Mindestjahresverbrauch)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub min_annual_consumption: Option<f64>,

    /// Maximum annual consumption for this tariff (Höchstjahresverbrauch)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_annual_consumption: Option<f64>,

    /// Description (Beschreibung)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
}

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

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

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

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

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

    #[test]
    fn test_tiered_tariff() {
        let param = TariffCalculationParameter {
            calculation_method: Some(TariffCalculationMethod::Tiers),
            min_annual_consumption: Some(0.0),
            max_annual_consumption: Some(10000.0),
            ..Default::default()
        };

        assert_eq!(
            param.calculation_method,
            Some(TariffCalculationMethod::Tiers)
        );
    }

    #[test]
    fn test_time_based_tariff() {
        let param = TariffCalculationParameter {
            calculation_method: Some(TariffCalculationMethod::None),
            tariff_time: Some(TariffTime::HighTariff),
            ..Default::default()
        };

        assert_eq!(param.tariff_time, Some(TariffTime::HighTariff));
    }

    #[test]
    fn test_default() {
        let param = TariffCalculationParameter::default();
        assert!(param.calculation_method.is_none());
        assert!(param.min_annual_consumption.is_none());
    }

    #[test]
    fn test_roundtrip() {
        let param = TariffCalculationParameter {
            calculation_method: Some(TariffCalculationMethod::None),
            tariff_time: Some(TariffTime::LowTariff),
            is_demand_based: Some(false),
            description: Some("Night rate tariff".to_string()),
            ..Default::default()
        };

        let json = serde_json::to_string(&param).unwrap();
        let parsed: TariffCalculationParameter = serde_json::from_str(&json).unwrap();
        assert_eq!(param, parsed);
    }

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