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

//! Borrowed `IfcClassificationReference` projection.
use crate::view::{borrowed_entity, optional_ref, optional_text, ClassificationView};
use crate::{ClassificationError, ClassificationResult};
borrowed_entity!(ClassificationReference, "IFCCLASSIFICATIONREFERENCE");
impl<'m> ClassificationReference<'m> {
    /// The `Location` (e.g. a URI) of the referenced classification item, when authored.
    pub fn location(self) -> ClassificationResult<Option<&'m str>> {
        optional_text(
            "IFCCLASSIFICATIONREFERENCE",
            self.id(),
            self.entity(),
            self.text_slot("Location")?,
            "Location",
        )
    }
    /// The `Identification` code of the referenced classification item, when authored.
    pub fn identification(self) -> ClassificationResult<Option<&'m str>> {
        optional_text(
            "IFCCLASSIFICATIONREFERENCE",
            self.id(),
            self.entity(),
            self.text_slot("Identification")?,
            "Identification",
        )
    }
    /// The `Name` of the referenced classification item, when authored.
    pub fn name(self) -> ClassificationResult<Option<&'m str>> {
        optional_text(
            "IFCCLASSIFICATIONREFERENCE",
            self.id(),
            self.entity(),
            self.text_slot("Name")?,
            "Name",
        )
    }
    /// Id of the `ReferencedSource` — the parent `IfcClassification` or `IfcClassificationReference` in the hierarchy — when authored.
    pub fn referenced_source_id(self) -> ClassificationResult<Option<ifc_model::EntityId>> {
        optional_ref(
            "IFCCLASSIFICATIONREFERENCE",
            self.id(),
            self.entity(),
            self.slot("ReferencedSource")?,
            "ReferencedSource",
        )
    }
    /// The `Description` of the referenced classification item, when authored.
    pub fn description(self) -> ClassificationResult<Option<&'m str>> {
        optional_text(
            "IFCCLASSIFICATIONREFERENCE",
            self.id(),
            self.entity(),
            self.text_slot("Description")?,
            "Description",
        )
    }
    /// The `Sort` order of the referenced classification item, when authored.
    pub fn sort(self) -> ClassificationResult<Option<&'m str>> {
        optional_text(
            "IFCCLASSIFICATIONREFERENCE",
            self.id(),
            self.entity(),
            self.text_slot("Sort")?,
            "Sort",
        )
    }
    /// Checks the `IfcExternalReference.WR1` rule: at least one of `Location`, `Identification`, or `Name` must be stated.
    pub fn validate(self) -> ClassificationResult<()> {
        if self.location()?.is_some() || self.identification()?.is_some() || self.name()?.is_some()
        {
            Ok(())
        } else {
            Err(ClassificationError::InvalidValue {
                entity: "IFCCLASSIFICATIONREFERENCE",
                id: self.id(),
                attribute: "WR1",
                value: "Location, Identification, and Name are all unstated".into(),
            })
        }
    }
}
impl<'m> ClassificationView<'m> {
    /// All `IfcClassificationReference` instances in the model.
    pub fn references(self) -> impl Iterator<Item = ClassificationReference<'m>> + 'm {
        self.model()
            .of_type("IFCCLASSIFICATIONREFERENCE")
            .map(move |(id, e)| ClassificationReference::from_known(id, e, self.release()))
    }
}