ifc-classification 0.2.2

Classification systems, document references, libraries, external references.
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

//! Borrowed `Ifcrelassociatesclassification` association projection.
use crate::assignment::{validate_assignment, AssociationSchema};
use crate::view::{
    borrowed_entity, optional_text, required_ref, required_refs, required_text, ClassificationView,
};
use crate::ClassificationResult;
use ifc_model::EntityId;
borrowed_entity!(ClassificationAssignment, "IFCRELASSOCIATESCLASSIFICATION");
impl<'m> ClassificationAssignment<'m> {
    /// The `GlobalId` of this `IfcRelAssociatesClassification`.
    pub fn global_id(self) -> ClassificationResult<&'m str> {
        required_text(
            "IFCRELASSOCIATESCLASSIFICATION",
            self.id(),
            self.entity(),
            self.text_slot("GlobalId")?,
            "GlobalId",
        )
    }
    /// Optional `Name` of the association relationship.
    pub fn name(self) -> ClassificationResult<Option<&'m str>> {
        optional_text(
            "IFCRELASSOCIATESCLASSIFICATION",
            self.id(),
            self.entity(),
            self.text_slot("Name")?,
            "Name",
        )
    }
    /// Optional `Description` of the association relationship.
    pub fn description(self) -> ClassificationResult<Option<&'m str>> {
        optional_text(
            "IFCRELASSOCIATESCLASSIFICATION",
            self.id(),
            self.entity(),
            self.text_slot("Description")?,
            "Description",
        )
    }
    /// Ids of the `RelatedObjects` being classified; non-empty per schema.
    pub fn related_object_ids(self) -> ClassificationResult<Vec<EntityId>> {
        required_refs(
            "IFCRELASSOCIATESCLASSIFICATION",
            self.id(),
            self.entity(),
            self.slot("RelatedObjects")?,
            "RelatedObjects",
        )
    }
    /// Id of the `RelatingClassification` (an `IfcClassification` or `IfcClassificationReference`).
    pub fn relating_classification_id(self) -> ClassificationResult<EntityId> {
        required_ref(
            "IFCRELASSOCIATESCLASSIFICATION",
            self.id(),
            self.entity(),
            self.slot("RelatingClassification")?,
            "RelatingClassification",
        )
    }
}
impl<'m> ClassificationView<'m> {
    /// All `IfcRelAssociatesClassification` instances in the model.
    pub fn classification_assignments(
        self,
    ) -> impl Iterator<Item = ClassificationAssignment<'m>> + 'm {
        self.model()
            .of_type("IFCRELASSOCIATESCLASSIFICATION")
            .map(move |(id, e)| ClassificationAssignment::from_known(id, e, self.release()))
    }
    /// Classification assignments naming `object` among their `RelatedObjects`, with the relating classification checked against `IfcClassificationSelect`; fails if `object` is unknown or a reference does not resolve.
    pub fn classification_assignments_for(
        self,
        object: EntityId,
    ) -> ClassificationResult<Vec<ClassificationAssignment<'m>>> {
        if self.model().get(object).is_none() {
            return Err(crate::ClassificationError::UnknownEntity { id: object });
        }
        let mut out = Vec::new();
        for assignment in self.classification_assignments() {
            let related = assignment.related_object_ids()?;
            if related.contains(&object) {
                let target = assignment.relating_classification_id()?;
                validate_assignment(
                    self,
                    assignment.id(),
                    &related,
                    target,
                    AssociationSchema {
                        relation: "IFCRELASSOCIATESCLASSIFICATION",
                        target_attribute: "RelatingClassification",
                    },
                )?;
                out.push(assignment);
            }
        }
        Ok(out)
    }
}