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

//! `IfcMaterialProfileSetUsage` and tapering authored fields.

use ifc_model::EntityId;

use crate::view::{borrowed_entity, optional_integer, optional_number, required_ref, MaterialView};
use crate::{CardinalPointReference, MaterialError, MaterialResult};

borrowed_entity!(MaterialProfileSetUsage, "IFCMATERIALPROFILESETUSAGE");
borrowed_entity!(
    MaterialProfileSetUsageTapering,
    "IFCMATERIALPROFILESETUSAGETAPERING"
);

fn cardinal(
    entity_type: &'static str,
    id: EntityId,
    entity: &ifc_model::Entity,
    slot: usize,
    attribute: &'static str,
) -> MaterialResult<Option<CardinalPointReference>> {
    let Some(value) = optional_integer(entity_type, id, entity, slot, attribute)? else {
        return Ok(None);
    };
    CardinalPointReference::new(value)
        .map(Some)
        .ok_or_else(|| MaterialError::InvalidValue {
            entity: entity_type,
            id,
            attribute,
            value: value.to_string(),
        })
}

fn positive_extent(
    entity_type: &'static str,
    id: EntityId,
    entity: &ifc_model::Entity,
    slot: usize,
) -> MaterialResult<Option<f64>> {
    let value = optional_number(entity_type, id, entity, slot, "ReferenceExtent")?;
    if value.is_some_and(|value| value <= 0.0) {
        return Err(MaterialError::InvalidValue {
            entity: entity_type,
            id,
            attribute: "ReferenceExtent",
            value: "expected a positive length".to_owned(),
        });
    }
    Ok(value)
}

macro_rules! usage_accessors {
    ($type:ident, $ifc_name:literal) => {
        impl $type<'_> {
            /// `ForProfileSet`. Required.
            pub fn profile_set_id(self) -> MaterialResult<EntityId> {
                required_ref(
                    $ifc_name,
                    self.id(),
                    self.entity(),
                    self.slot("ForProfileSet")?,
                    "ForProfileSet",
                )
            }

            /// `CardinalPoint`, if given. Must decode to a positive
            /// `IfcCardinalPointReference`.
            pub fn cardinal_point(self) -> MaterialResult<Option<CardinalPointReference>> {
                cardinal(
                    $ifc_name,
                    self.id(),
                    self.entity(),
                    self.slot("CardinalPoint")?,
                    "CardinalPoint",
                )
            }

            /// `ReferenceExtent`, if given. Must be strictly positive when
            /// present.
            pub fn reference_extent(self) -> MaterialResult<Option<f64>> {
                positive_extent(
                    $ifc_name,
                    self.id(),
                    self.entity(),
                    self.slot("ReferenceExtent")?,
                )
            }
        }
    };
}
usage_accessors!(MaterialProfileSetUsage, "IFCMATERIALPROFILESETUSAGE");
usage_accessors!(
    MaterialProfileSetUsageTapering,
    "IFCMATERIALPROFILESETUSAGETAPERING"
);

impl MaterialProfileSetUsageTapering<'_> {
    /// `IfcMaterialProfileSetUsageTapering.ForProfileEndSet`. Required.
    pub fn end_profile_set_id(self) -> MaterialResult<EntityId> {
        required_ref(
            "IFCMATERIALPROFILESETUSAGETAPERING",
            self.id(),
            self.entity(),
            self.slot("ForProfileEndSet")?,
            "ForProfileEndSet",
        )
    }

    /// `IfcMaterialProfileSetUsageTapering.CardinalEndPoint`, if given.
    /// Must decode to a positive `IfcCardinalPointReference`.
    pub fn cardinal_end_point(self) -> MaterialResult<Option<CardinalPointReference>> {
        cardinal(
            "IFCMATERIALPROFILESETUSAGETAPERING",
            self.id(),
            self.entity(),
            self.slot("CardinalEndPoint")?,
            "CardinalEndPoint",
        )
    }
}

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

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