ifc-material 0.3.0

//! `IfcMaterialProperties` and its direct material/property links.
//!
//! IFC4 and IFC4X3 declare a concrete `IfcMaterialProperties` (an
//! `IfcExtendedProperties` subtype). IFC2X3 declares it ABSTRACT with only a
//! `Material` attribute, so an instance in an IFC2X3 model is refused with
//! [`crate::MaterialError::EntityNotInSchema`].

use ifc_model::EntityId;

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

borrowed_entity!(MaterialProperties, "IFCMATERIALPROPERTIES");

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

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

    /// `IfcMaterialProperties.Properties`, the ids of the property set's
    /// `IfcProperty` members. Required and must be non-empty.
    pub fn property_ids(self) -> MaterialResult<Vec<EntityId>> {
        required_refs(
            "IFCMATERIALPROPERTIES",
            self.id(),
            self.entity(),
            self.slot("Properties")?,
            "Properties",
            1,
        )
    }

    /// `IfcMaterialProperties.Material`, the id of the `IfcMaterialDefinition`
    /// these properties describe. Required.
    pub fn material_id(self) -> MaterialResult<EntityId> {
        required_ref(
            "IFCMATERIALPROPERTIES",
            self.id(),
            self.entity(),
            self.slot("Material")?,
            "Material",
        )
    }
}

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

    /// Iterates every `IfcMaterialProperties` whose `Material` attribute
    /// resolves to `material`, surfacing malformed records as errors rather
    /// than skipping them.
    pub fn properties_for(
        self,
        material: EntityId,
    ) -> impl Iterator<Item = MaterialResult<MaterialProperties<'m>>> + 'm {
        self.material_properties()
            .filter_map(move |properties| match properties.material_id() {
                Ok(id) if id == material => Some(Ok(properties)),
                Ok(_) => None,
                Err(error) => Some(Err(error)),
            })
    }
}