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

//! `IfcMaterialLayerSetUsage` authored fields.
//!
//! IFC2X3 declares the first four attributes; `ReferenceExtent` is IFC4
//! onwards.

use ifc_model::EntityId;

use crate::view::{
    borrowed_entity, optional_number, required_enum, required_number, required_ref, MaterialView,
};
use crate::{DirectionSense, LayerSetDirection, MaterialError, MaterialResult};

borrowed_entity!(MaterialLayerSetUsage, "IFCMATERIALLAYERSETUSAGE");

impl MaterialLayerSetUsage<'_> {
    /// `IfcMaterialLayerSetUsage.ForLayerSet`. Required.
    pub fn layer_set_id(self) -> MaterialResult<EntityId> {
        required_ref(
            "IFCMATERIALLAYERSETUSAGE",
            self.id(),
            self.entity(),
            self.slot("ForLayerSet")?,
            "ForLayerSet",
        )
    }

    /// `IfcMaterialLayerSetUsage.LayerSetDirection`. Required.
    pub fn layer_set_direction(self) -> MaterialResult<LayerSetDirection> {
        let token = required_enum(
            "IFCMATERIALLAYERSETUSAGE",
            self.id(),
            self.entity(),
            self.slot("LayerSetDirection")?,
            "LayerSetDirection",
        )?;
        LayerSetDirection::parse(token).ok_or_else(|| MaterialError::InvalidValue {
            entity: "IFCMATERIALLAYERSETUSAGE",
            id: self.id(),
            attribute: "LayerSetDirection",
            value: token.to_owned(),
        })
    }

    /// `IfcMaterialLayerSetUsage.DirectionSense`. Required.
    pub fn direction_sense(self) -> MaterialResult<DirectionSense> {
        let token = required_enum(
            "IFCMATERIALLAYERSETUSAGE",
            self.id(),
            self.entity(),
            self.slot("DirectionSense")?,
            "DirectionSense",
        )?;
        DirectionSense::parse(token).ok_or_else(|| MaterialError::InvalidValue {
            entity: "IFCMATERIALLAYERSETUSAGE",
            id: self.id(),
            attribute: "DirectionSense",
            value: token.to_owned(),
        })
    }

    /// `IfcMaterialLayerSetUsage.OffsetFromReferenceLine`. Required.
    pub fn offset_from_reference_line(self) -> MaterialResult<f64> {
        required_number(
            "IFCMATERIALLAYERSETUSAGE",
            self.id(),
            self.entity(),
            self.slot("OffsetFromReferenceLine")?,
            "OffsetFromReferenceLine",
        )
    }

    /// `IfcMaterialLayerSetUsage.ReferenceExtent`, if given. Must be
    /// strictly positive when present. `NotInSchema` for IFC2X3.
    pub fn reference_extent(self) -> MaterialResult<Option<f64>> {
        let value = optional_number(
            "IFCMATERIALLAYERSETUSAGE",
            self.id(),
            self.entity(),
            self.slot("ReferenceExtent")?,
            "ReferenceExtent",
        )?;
        if value.is_some_and(|value| value <= 0.0) {
            return Err(MaterialError::InvalidValue {
                entity: "IFCMATERIALLAYERSETUSAGE",
                id: self.id(),
                attribute: "ReferenceExtent",
                value: "expected a positive length".to_owned(),
            });
        }
        Ok(value)
    }
}

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