ifc-material 0.3.0

Material definitions: layer sets, profile sets, constituents, usage.
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

//! Material lists, classifications, and resource-level relationships.
//!
//! `IfcMaterialList` and `IfcMaterialClassificationRelationship` keep their
//! layout in every release. `IfcMaterialRelationship` is IFC4 onwards; IFC4X3
//! renamed its `Expression` to `MaterialExpression` at the same position.

use ifc_model::EntityId;

use crate::view::{borrowed_entity, optional_text, required_ref, required_refs, MaterialView};
use crate::MaterialResult;

borrowed_entity!(
    MaterialClassificationRelationship,
    "IFCMATERIALCLASSIFICATIONRELATIONSHIP"
);
borrowed_entity!(MaterialList, "IFCMATERIALLIST");
borrowed_entity!(MaterialRelationship, "IFCMATERIALRELATIONSHIP");

impl MaterialClassificationRelationship<'_> {
    /// `IfcMaterialClassificationRelationship.MaterialClassifications`.
    /// Required and must be non-empty.
    pub fn classification_ids(self) -> MaterialResult<Vec<EntityId>> {
        required_refs(
            "IFCMATERIALCLASSIFICATIONRELATIONSHIP",
            self.id(),
            self.entity(),
            self.slot("MaterialClassifications")?,
            "MaterialClassifications",
            1,
        )
    }

    /// `IfcMaterialClassificationRelationship.ClassifiedMaterial`. Required.
    pub fn material_id(self) -> MaterialResult<EntityId> {
        required_ref(
            "IFCMATERIALCLASSIFICATIONRELATIONSHIP",
            self.id(),
            self.entity(),
            self.slot("ClassifiedMaterial")?,
            "ClassifiedMaterial",
        )
    }
}

impl MaterialList<'_> {
    /// `IfcMaterialList.Materials`, the ids of the constituent
    /// `IfcMaterial` entities. Required and must be non-empty.
    pub fn material_ids(self) -> MaterialResult<Vec<EntityId>> {
        required_refs(
            "IFCMATERIALLIST",
            self.id(),
            self.entity(),
            self.slot("Materials")?,
            "Materials",
            1,
        )
    }
}

impl<'m> MaterialRelationship<'m> {
    /// `IfcMaterialRelationship.Name`, if given.
    pub fn name(self) -> MaterialResult<Option<&'m str>> {
        optional_text(
            "IFCMATERIALRELATIONSHIP",
            self.id(),
            self.entity(),
            self.slot("Name")?,
            "Name",
        )
    }

    /// `IfcMaterialRelationship.Description`, if given.
    pub fn description(self) -> MaterialResult<Option<&'m str>> {
        optional_text(
            "IFCMATERIALRELATIONSHIP",
            self.id(),
            self.entity(),
            self.slot("Description")?,
            "Description",
        )
    }

    /// `IfcMaterialRelationship.RelatingMaterial`. Required.
    pub fn relating_material_id(self) -> MaterialResult<EntityId> {
        required_ref(
            "IFCMATERIALRELATIONSHIP",
            self.id(),
            self.entity(),
            self.slot("RelatingMaterial")?,
            "RelatingMaterial",
        )
    }

    /// `IfcMaterialRelationship.RelatedMaterials`. Required and must be
    /// non-empty.
    pub fn related_material_ids(self) -> MaterialResult<Vec<EntityId>> {
        required_refs(
            "IFCMATERIALRELATIONSHIP",
            self.id(),
            self.entity(),
            self.slot("RelatedMaterials")?,
            "RelatedMaterials",
            1,
        )
    }

    /// `IfcMaterialRelationship.Expression` (IFC4X3: `MaterialExpression`),
    /// if given.
    pub fn expression(self) -> MaterialResult<Option<&'m str>> {
        optional_text(
            "IFCMATERIALRELATIONSHIP",
            self.id(),
            self.entity(),
            self.slot("Expression")?,
            "Expression",
        )
    }
}

impl<'m> MaterialView<'m> {
    /// Iterates every `IfcMaterialClassificationRelationship` in the model.
    pub fn classification_relationships(
        self,
    ) -> impl Iterator<Item = MaterialClassificationRelationship<'m>> + 'm {
        let release = self.release();
        self.model()
            .of_type("IFCMATERIALCLASSIFICATIONRELATIONSHIP")
            .map(move |(id, entity)| {
                MaterialClassificationRelationship::from_known(id, entity, release)
            })
    }

    /// Iterates every `IfcMaterialList` instance in the model.
    pub fn material_lists(self) -> impl Iterator<Item = MaterialList<'m>> + 'm {
        let release = self.release();
        self.model()
            .of_type("IFCMATERIALLIST")
            .map(move |(id, entity)| MaterialList::from_known(id, entity, release))
    }

    /// Iterates every `IfcMaterialRelationship` instance in the model.
    pub fn material_relationships(self) -> impl Iterator<Item = MaterialRelationship<'m>> + 'm {
        let release = self.release();
        self.model()
            .of_type("IFCMATERIALRELATIONSHIP")
            .map(move |(id, entity)| MaterialRelationship::from_known(id, entity, release))
    }
}