Class Material

src/ifctester/ifctester/facet.py:922–999

class Material(Facet):
    def __init__(self, value=None, uri=None, cardinality: Cardinality = "required", instructions=None):
        self.parameters = ["value", "@uri", "@cardinality", "@instructions"]
        self.applicability_templates = [
            "All data with a {value} material",
            "All data with a material",
        ]
        self.requirement_templates = [
            "Shall have a material of {value}",
            "Shall have a material",
        ]
        self.prohibited_templates = [
            "Shall not have a material of {value}",
            "Shall not have a material",
        ]
        super().__init__(value, uri, cardinality, instructions)

    def filter(
        self, ifc_file: ifcopenshell.file, elements: Optional[list[ifcopenshell.entity_instance]]
    ) -> list[ifcopenshell.entity_instance]:
        if isinstance(elements, list):
            return super().filter(ifc_file, elements)
        return ifc_file.by_type("IfcObjectDefinition")

    def __call__(self, inst: ifcopenshell.entity_instance, logger: Optional[Logger] = None) -> MaterialResult:
        material = ifcopenshell.util.element.get_material(inst, should_skip_usage=True)

        is_pass = material is not None
        reason = None

        if not is_pass:
            if self.cardinality == "optional":
                return MaterialResult(True)
            reason = {"type": "NOVALUE"}

        if is_pass and self.value:
            if material.is_a("IfcMaterial"):
                values = {material.Name, getattr(material, "Category", None)}
            elif material.is_a("IfcMaterialList"):
                values = set()
                for mat in material.Materials or []:
                    values.update([mat.Name, getattr(mat, "Category", None)])
            elif material.is_a("IfcMaterialLayerSet"):
                values = {material.LayerSetName}
                for item in material.MaterialLayers or []:
                    values.update(
                        [
                            getattr(item, "Name", None),
                            getattr(item, "Category", None),
                            item.Material.Name,
                            getattr(item.Material, "Category", None),
                        ]
                    )
            elif material.is_a("IfcMaterialProfileSet"):
                values = {material.Name}
                for item in material.MaterialProfiles or []:
                    values.update(
                        [item.Name, item.Category, item.Material.Name, getattr(item.Material, "Category", None)]