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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

//! Location properties (Standorteigenschaften) business object.
//!
//! Represents properties and characteristics of a physical location.

use serde::{Deserialize, Serialize};

use crate::com::{Address, GeoCoordinates};
use crate::traits::{Bo4eMeta, Bo4eObject};

/// Properties of a physical location.
///
/// German: Standorteigenschaften
///
/// Location properties describe characteristics of a physical
/// site, such as address, coordinates, and site-specific details.
///
/// # Example
///
/// ```rust
/// use bo4e_core::bo::LocationProperties;
///
/// let props = LocationProperties {
///     location_properties_id: Some("LOC001".to_string()),
///     building_type: Some("Residential".to_string()),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct LocationProperties {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Location properties ID (Standorteigenschaften-ID)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location_properties_id: Option<String>,

    /// Location address (Adresse)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub address: Option<Address>,

    /// Geographic coordinates (Geokoordinaten)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub coordinates: Option<GeoCoordinates>,

    /// Building type (Gebaeudeart)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub building_type: Option<String>,

    /// Construction year (Baujahr)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub construction_year: Option<i32>,

    /// Floor area in square meters (Flaeche)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub floor_area: Option<f64>,

    /// Number of floors (Anzahl Etagen)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub number_of_floors: Option<i32>,

    /// Number of residential units (Anzahl Wohneinheiten)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub number_of_units: Option<i32>,

    /// Heating type (Heizungsart)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub heating_type: Option<String>,

    /// Energy efficiency class (Energieeffizienzklasse)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub energy_efficiency_class: Option<String>,

    /// Has solar installation (Hat Solaranlage)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub has_solar: Option<bool>,

    /// Has electric vehicle charging (Hat E-Ladestation)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub has_ev_charging: Option<bool>,

    /// Has heat pump (Hat Waermepumpe)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub has_heat_pump: Option<bool>,

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

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

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

    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_location_properties_creation() {
        let props = LocationProperties {
            location_properties_id: Some("LOC001".to_string()),
            building_type: Some("Residential".to_string()),
            ..Default::default()
        };

        assert_eq!(props.location_properties_id, Some("LOC001".to_string()));
    }

    #[test]
    fn test_serialize() {
        let props = LocationProperties {
            meta: Bo4eMeta::with_type("Standorteigenschaften"),
            location_properties_id: Some("LOC001".to_string()),
            ..Default::default()
        };

        let json = serde_json::to_string(&props).unwrap();
        assert!(json.contains(r#""_typ":"Standorteigenschaften""#));
    }

    #[test]
    fn test_roundtrip() {
        let props = LocationProperties {
            meta: Bo4eMeta::with_type("Standorteigenschaften"),
            location_properties_id: Some("LOC001".to_string()),
            building_type: Some("Residential".to_string()),
            construction_year: Some(2010),
            floor_area: Some(150.0),
            number_of_floors: Some(2),
            has_solar: Some(true),
            ..Default::default()
        };

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

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