aas 0.4.0

Data type bindings for the Asset Administration Shell Specs
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273

use crate::part1::ToJsonMetamodel;
use crate::part1::v3_1::attributes::data_specification::HasDataSpecification;
use crate::part1::v3_1::attributes::qualifiable::Qualifiable;
use crate::part1::v3_1::attributes::referable::Referable;
use crate::part1::v3_1::attributes::semantics::HasSemantics;
use crate::part1::v3_1::core::SpecificAssetId;
use crate::part1::v3_1::primitives::Identifier;
use crate::part1::v3_1::submodel_elements::SubmodelElement;
use serde::{Deserialize, Serialize};
use strum::{Display, EnumString};
#[cfg(feature = "openapi")]
use utoipa::ToSchema;

/// The entity submodel element is designed to be used in submodels defining the relationship between the parts of the composite asset
/// it is composed of (e.g. bill of material).
/// These parts are called entities. Not all entities have a global asset ID.
#[derive(Clone, PartialEq, Debug, Deserialize, Serialize, Display, EnumString)]
#[serde(tag = "entityType")]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[cfg_attr(
    feature = "xml",
    serde(from = "xml::EntityXMLProxy", into = "xml::EntityXMLProxy")
)]
pub enum Entity {
    /// There is no separate Asset Administration Shell for co-managed entities.
    /// Co-managed entities need to be part of a self-managed entity.
    CoManagedEntity(EntityInner),

    /// Self-managed entities have their own Asset Administration Shell but can be part of another composite self-managed entity.
    /// The asset represented by an Asset Administration Shell is a self-managed entity per definition
    SelfManagedEntity(EntityInner),
}

#[derive(Clone, PartialEq, Debug, Deserialize, Serialize, Default)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
pub struct EntityInner {
    // Inherited from DataElement
    #[serde(flatten)]
    pub referable: Referable,

    #[serde(flatten)]
    pub semantics: HasSemantics,

    #[serde(flatten)]
    pub qualifiable: Qualifiable,

    #[serde(flatten)]
    pub embedded_data_specifications: HasDataSpecification,
    // ----- end inheritance
    /// Statement applicable to the entity,
    /// each statement described by submodel element - typically with a qualified value
    pub statements: Option<Vec<SubmodelElement>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "globalAssetId")]
    pub global_asset_id: Option<Identifier>,

    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "specificAssetId")]
    pub specific_asset_id: Option<Vec<SpecificAssetId>>,
}

impl ToJsonMetamodel for Entity {
    type Error = ();

    fn to_json_metamodel(&self) -> Result<String, Self::Error> {
        // TODO: Add modelType
        match self {
            Entity::CoManagedEntity(_) => Ok(r#"{"entityType":"CoManagedEntity"}"#.into()),
            Entity::SelfManagedEntity(_) => Ok(r#"{"entityType":"SelfManagedEntity"}"#.into()),
        }
    }
}

pub(crate) mod xml {
    use crate::part1::v3_1::attributes::data_specification::{
        EmbeddedDataSpecification, HasDataSpecification,
    };
    use crate::part1::v3_1::attributes::extension::{Extension, HasExtensions};
    use crate::part1::v3_1::attributes::qualifiable::{Qualifiable, Qualifier};
    use crate::part1::v3_1::attributes::referable::Referable;
    use crate::part1::v3_1::attributes::semantics::HasSemantics;
    use crate::part1::v3_1::core::SpecificAssetId;
    use crate::part1::v3_1::primitives::Identifier;
    use crate::part1::v3_1::primitives::xml::LangStringTextType;
    use crate::part1::v3_1::reference::Reference;
    use crate::part1::v3_1::submodel_elements::SubmodelElement;
    use crate::part1::v3_1::submodel_elements::entity::{Entity, EntityInner};
    use crate::utilities::deserialize_empty_identifier_as_none;
    use serde::{Deserialize, Serialize};

    #[derive(Serialize, Deserialize)]
    pub enum EntityType {
        CoManagedEntity,
        SelfManagedEntity,
    }

    #[derive(Serialize, Deserialize)]
    pub struct EntityXMLProxy {
        // Inherited from DataElement
        #[serde(skip_serializing_if = "Option::is_none")]
        // use case where "" is needed or can this be ignored?
        #[serde(default)]
        #[serde(deserialize_with = "deserialize_empty_identifier_as_none")]
        #[serde(rename = "idShort")]
        pub id_short: Option<Identifier>,

        #[serde(skip_serializing_if = "Option::is_none")]
        #[serde(rename = "displayName")]
        pub display_name: Option<LangStringTextType>,

        #[serde(skip_serializing_if = "Option::is_none")]
        pub description: Option<LangStringTextType>,

        #[serde(skip_serializing_if = "Option::is_none")]
        #[deprecated]
        pub category: Option<String>,

        #[serde(skip_serializing_if = "Option::is_none")]
        #[serde(rename = "extensions")]
        pub extension: Option<Vec<Extension>>,

        #[serde(skip_serializing_if = "Option::is_none")]
        #[serde(rename = "semanticId")]
        pub semantic_id: Option<Reference>,

        #[serde(skip_serializing_if = "Option::is_none")]
        #[serde(rename = "supplementalSemanticIds")]
        pub supplemental_semantic_ids: Option<Vec<Reference>>,

        #[serde(skip_serializing_if = "Option::is_none")]
        pub qualifiers: Option<Vec<Qualifier>>,

        #[serde(skip_serializing_if = "Option::is_none")]
        #[serde(rename = "embeddedDataSpecifications")]
        embedded_data_specifications: Option<Vec<EmbeddedDataSpecification>>,

        /// Statement applicable to the entity,
        /// each statement described by submodel element - typically with a qualified value
        pub statements: Option<Vec<SubmodelElement>>,

        #[serde(skip_serializing_if = "Option::is_none")]
        #[serde(rename = "globalAssetId")]
        pub global_asset_id: Option<Identifier>,

        #[serde(skip_serializing_if = "Option::is_none")]
        #[serde(rename = "specificAssetId")]
        pub specific_asset_id: Option<Vec<SpecificAssetId>>,

        #[serde(rename = "entityType")]
        pub ty: EntityType,
    }

    impl From<super::Entity> for EntityXMLProxy {
        fn from(value: super::Entity) -> Self {
            match value {
                Entity::CoManagedEntity(value) => Self {
                    id_short: value.referable.id_short,
                    display_name: value
                        .referable
                        .display_name
                        .map(|values| LangStringTextType { values }),
                    description: value
                        .referable
                        .description
                        .map(|values| LangStringTextType { values }),
                    #[allow(deprecated)]
                    category: value.referable.category,
                    extension: value.referable.extensions.extension,
                    semantic_id: value.semantics.semantic_id,
                    supplemental_semantic_ids: value.semantics.supplemental_semantic_ids,
                    qualifiers: value.qualifiable.qualifiers,
                    embedded_data_specifications: value
                        .embedded_data_specifications
                        .embedded_data_specifications,
                    statements: value.statements,
                    global_asset_id: value.global_asset_id,
                    specific_asset_id: value.specific_asset_id,
                    ty: EntityType::CoManagedEntity,
                },
                Entity::SelfManagedEntity(value) => Self {
                    id_short: value.referable.id_short,
                    display_name: value
                        .referable
                        .display_name
                        .map(|values| LangStringTextType { values }),
                    description: value
                        .referable
                        .description
                        .map(|values| LangStringTextType { values }),
                    #[allow(deprecated)]
                    category: value.referable.category,
                    extension: value.referable.extensions.extension,
                    semantic_id: value.semantics.semantic_id,
                    supplemental_semantic_ids: value.semantics.supplemental_semantic_ids,
                    qualifiers: value.qualifiable.qualifiers,
                    embedded_data_specifications: value
                        .embedded_data_specifications
                        .embedded_data_specifications,
                    statements: value.statements,
                    global_asset_id: value.global_asset_id,
                    specific_asset_id: value.specific_asset_id,
                    ty: EntityType::SelfManagedEntity,
                },
            }
        }
    }

    impl From<EntityXMLProxy> for super::Entity {
        fn from(value: EntityXMLProxy) -> Self {
            let inner = EntityInner {
                referable: Referable {
                    id_short: value.id_short,
                    display_name: value.display_name.map(LangStringTextType::into),
                    description: value.description.map(LangStringTextType::into),
                    #[allow(deprecated)]
                    category: value.category,
                    extensions: HasExtensions {
                        extension: value.extension,
                    },
                },
                semantics: HasSemantics {
                    semantic_id: value.semantic_id,
                    supplemental_semantic_ids: value.supplemental_semantic_ids,
                },
                qualifiable: Qualifiable {
                    qualifiers: value.qualifiers,
                },
                embedded_data_specifications: HasDataSpecification {
                    embedded_data_specifications: value.embedded_data_specifications,
                },

                statements: value.statements,
                global_asset_id: value.global_asset_id,
                specific_asset_id: value.specific_asset_id,
            };

            match value.ty {
                EntityType::CoManagedEntity => Self::CoManagedEntity(inner),
                EntityType::SelfManagedEntity => Self::SelfManagedEntity(inner),
            }
        }
    }
}

#[cfg(all(feature = "json", test))]
mod tests {
    use crate::part1::v3_1::attributes::referable::Referable;
    use crate::part1::v3_1::primitives::Identifier;
    use crate::part1::v3_1::submodel_elements::entity::{Entity, EntityInner};

    #[test]
    fn deserialize_simple() {
        let json = r#"
        {
            "idShort": "Example1",
            "entityType": "SelfManagedEntity",
            "globalAssetId": "https://example.com"
        }"#;

        let expected = Entity::SelfManagedEntity(EntityInner {
            referable: Referable {
                id_short: Some(Identifier::try_from("Example1").unwrap()),
                ..Default::default()
            },
            global_asset_id: Some(Identifier::try_from("https://example.com").unwrap()),
            ..Default::default()
        });

        let actual = serde_json::from_str::<Entity>(json).unwrap();
        assert_eq!(actual, expected)
    }
}