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

//! `IfcMaterialConstituent` semantics.
//!
//! IFC4 onwards. IFC2X3 declares no constituent, so every accessor on a
//! record in an IFC2X3 model fails with `EntityNotInSchema`.

use ifc_model::EntityId;

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

borrowed_entity!(MaterialConstituent, "IFCMATERIALCONSTITUENT");

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

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

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

    /// `IfcMaterialConstituent.Fraction`, if given. Must be in `0.0..=1.0`
    /// when present.
    pub fn fraction(self) -> MaterialResult<Option<f64>> {
        let value = optional_number(
            "IFCMATERIALCONSTITUENT",
            self.id(),
            self.entity(),
            self.slot("Fraction")?,
            "Fraction",
        )?;
        if value.is_some_and(|value| !(0.0..=1.0).contains(&value)) {
            return Err(MaterialError::InvalidValue {
                entity: "IFCMATERIALCONSTITUENT",
                id: self.id(),
                attribute: "Fraction",
                value: "expected a normalized ratio in 0..=1".to_owned(),
            });
        }
        Ok(value)
    }

    /// `IfcMaterialConstituent.Category`, if given.
    pub fn category(self) -> MaterialResult<Option<&'m str>> {
        optional_text(
            "IFCMATERIALCONSTITUENT",
            self.id(),
            self.entity(),
            self.slot("Category")?,
            "Category",
        )
    }
}

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