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

//! Borrowed `IfcDocumentReference` projection.
use crate::view::{borrowed_entity, optional_ref, optional_text, ClassificationView};
use crate::{ClassificationError, ClassificationResult};
borrowed_entity!(DocumentReference, "IFCDOCUMENTREFERENCE");
impl<'m> DocumentReference<'m> {
    /// The `Location` (e.g. a URI) of the referenced document, when authored.
    pub fn location(self) -> ClassificationResult<Option<&'m str>> {
        optional_text(
            "IFCDOCUMENTREFERENCE",
            self.id(),
            self.entity(),
            self.text_slot("Location")?,
            "Location",
        )
    }
    /// The `Identification` code of the referenced document, when authored.
    pub fn identification(self) -> ClassificationResult<Option<&'m str>> {
        optional_text(
            "IFCDOCUMENTREFERENCE",
            self.id(),
            self.entity(),
            self.text_slot("Identification")?,
            "Identification",
        )
    }
    /// The `Name` of the referenced document; mutually exclusive with `referenced_document_id`.
    pub fn name(self) -> ClassificationResult<Option<&'m str>> {
        optional_text(
            "IFCDOCUMENTREFERENCE",
            self.id(),
            self.entity(),
            self.text_slot("Name")?,
            "Name",
        )
    }
    /// The `Description` of the referenced document, when authored.
    pub fn description(self) -> ClassificationResult<Option<&'m str>> {
        optional_text(
            "IFCDOCUMENTREFERENCE",
            self.id(),
            self.entity(),
            self.text_slot("Description")?,
            "Description",
        )
    }
    /// Id of the `ReferencedDocument` (an `IfcDocumentInformation`); mutually exclusive with `name`.
    pub fn referenced_document_id(self) -> ClassificationResult<Option<ifc_model::EntityId>> {
        optional_ref(
            "IFCDOCUMENTREFERENCE",
            self.id(),
            self.entity(),
            self.slot("ReferencedDocument")?,
            "ReferencedDocument",
        )
    }
    /// Checks `IfcExternalReference.WR1` (at least one of `Location`, `Identification`, `Name` stated) and the local `WR1` rule that exactly one of `Name` and `ReferencedDocument` is stated.
    pub fn validate(self) -> ClassificationResult<()> {
        if self.location()?.is_none() && self.identification()?.is_none() && self.name()?.is_none()
        {
            return Err(ClassificationError::InvalidValue {
                entity: "IFCDOCUMENTREFERENCE",
                id: self.id(),
                attribute: "IfcExternalReference.WR1",
                value: "Location, Identification, and Name are all unstated".into(),
            });
        }
        if self.name()?.is_some() ^ self.referenced_document_id()?.is_some() {
            Ok(())
        } else {
            Err(ClassificationError::InvalidValue {
                entity: "IFCDOCUMENTREFERENCE",
                id: self.id(),
                attribute: "WR1",
                value: "exactly one of Name and ReferencedDocument must be stated".into(),
            })
        }
    }
}
impl<'m> ClassificationView<'m> {
    /// All `IfcDocumentReference` instances in the model.
    pub fn document_references(self) -> impl Iterator<Item = DocumentReference<'m>> + 'm {
        self.model()
            .of_type("IFCDOCUMENTREFERENCE")
            .map(move |(id, e)| DocumentReference::from_known(id, e, self.release()))
    }
}