IfcOpenShell/src/ifcopenshell-python/test/api/material/test_remove_material.py

# IfcOpenShell - IFC toolkit and geometry engine
# Copyright (C) 2022 Dion Moult <dion@thinkmoult.com>
#
# This file is part of IfcOpenShell.
#
# IfcOpenShell is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# IfcOpenShell is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.

import test.bootstrap
import ifcopenshell.api


class TestRemoveMaterialIFC2X3(test.bootstrap.IFC2X3):
    def test_removing_material(self):
        material = ifcopenshell.api.run("material.add_material", self.file)
        ifcopenshell.api.run("material.remove_material", self.file, material=material)
        assert len(self.file.by_type("IfcMaterial")) == 0

    def test_removing_material_with_associations(self):
        wall = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcWall")
        material = ifcopenshell.api.run("material.add_material", self.file)
        ifcopenshell.api.run("material.assign_material", self.file, products=[wall], material=material)
        ifcopenshell.api.run("material.remove_material", self.file, material=material)
        assert len(self.file.by_type("IfcMaterial")) == 0
        assert len(self.file.by_type("IfcRelAssociatesMaterial")) == 0

    def test_removing_material_in_layer(self):
        wall = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcWall")
        material = ifcopenshell.api.run("material.add_material", self.file)
        material_set = ifcopenshell.api.run("material.add_material_set", self.file, set_type="IfcMaterialLayerSet")
        ifcopenshell.api.run("material.add_layer", self.file, layer_set=material_set, material=material)
        ifcopenshell.api.run("material.assign_material", self.file, products=[wall], material=material_set)
        assert len(self.file.by_type("IfcMaterialLayerSet")[0].MaterialLayers) == 1
        ifcopenshell.api.run("material.remove_material", self.file, material=material)
        assert len(self.file.by_type("IfcMaterial")) == 0
        assert len(self.file.by_type("IfcRelAssociatesMaterial")) == 1
        assert len(self.file.by_type("IfcMaterialLayerSet")[0].MaterialLayers) == 0

    def test_removing_material_in_list(self):
        wall = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcWall")
        material = ifcopenshell.api.run("material.add_material", self.file)
        material_set = ifcopenshell.api.run("material.add_material_set", self.file, set_type="IfcMaterialList")
        ifcopenshell.api.run("material.add_list_item", self.file, material_list=material_set, material=material)
        ifcopenshell.api.run("material.assign_material", self.file, products=[wall], material=material_set)
        assert len(self.file.by_type("IfcMaterialList")[0].Materials) == 1
        ifcopenshell.api.run("material.remove_material", self.file, material=material)
        assert len(self.file.by_type("IfcMaterial")) == 0
        assert len(self.file.by_type("IfcRelAssociatesMaterial")) == 1
        assert len(self.file.by_type("IfcMaterialList")[0].Materials) == 0

    def test_removing_a_material_with_a_style_definition(self):
        ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcProject")
        context = ifcopenshell.api.run("context.add_context", self.file, context_type="Model")
        material = ifcopenshell.api.run("material.add_material", self.file)
        style = ifcopenshell.api.run("style.add_style", self.file)
        ifcopenshell.api.run("style.assign_material_style", self.file, material=material, style=style, context=context)
        assert len(self.file.by_type("IfcMaterialDefinitionRepresentation")) == 1
        assert len(self.file.by_type("IfcStyledRepresentation")) == 1
        assert len(self.file.by_type("IfcStyledItem")) == 1
        assert len(self.file.by_type("IfcSurfaceStyle")) == 1
        ifcopenshell.api.run("material.remove_material", self.file, material=material)
        assert len(self.file.by_type("IfcMaterial")) == 0
        assert len(self.file.by_type("IfcMaterialDefinitionRepresentation")) == 0
        assert len(self.file.by_type("IfcStyledRepresentation")) == 0
        assert len(self.file.by_type("IfcStyledItem")) == 0
        assert len(self.file.by_type("IfcSurfaceStyle")) == 1

    def test_removing_a_material_with_properties(self):
        def get_material_props(material: ifcopenshell.entity_instance) -> list[ifcopenshell.entity_instance]:
            if self.file.schema != "IFC2X3":
                return material.HasProperties
            return [i for i in self.file.get_inverse(material) if i.is_a("IfcMaterialProperties")]

        material = ifcopenshell.api.run("material.add_material", self.file)
        pset = ifcopenshell.api.run("pset.add_pset", self.file, product=material, name="Foo_Bar")
        ifcopenshell.api.run("pset.edit_pset", self.file, pset=pset, properties={"Foo": "Bar"})
        assert get_material_props(material)
        ifcopenshell.api.run("material.remove_material", self.file, material=material)
        assert len(self.file.by_type("IfcMaterialProperties")) == 0
        assert len(self.file.by_type("IfcPropertySingleValue")) == 0


class TestRemoveMaterialIFC4(test.bootstrap.IFC4, TestRemoveMaterialIFC2X3):
    # IfcMaterialProfileSet added in IFC4
    def test_removing_material_in_profile(self):
        wall = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcWall")
        material = ifcopenshell.api.run("material.add_material", self.file)
        material_set = ifcopenshell.api.run("material.add_material_set", self.file, set_type="IfcMaterialProfileSet")
        ifcopenshell.api.run("material.add_profile", self.file, profile_set=material_set, material=material)
        ifcopenshell.api.run("material.assign_material", self.file, products=[wall], material=material_set)
        assert len(self.file.by_type("IfcMaterialProfileSet")[0].MaterialProfiles) == 1
        ifcopenshell.api.run("material.remove_material", self.file, material=material)
        assert len(self.file.by_type("IfcMaterial")) == 0
        assert len(self.file.by_type("IfcRelAssociatesMaterial")) == 1
        assert len(self.file.by_type("IfcMaterialProfileSet")[0].MaterialProfiles) == 0

    def test_removing_material_in_constituent(self):
        wall = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcWall")
        material = ifcopenshell.api.run("material.add_material", self.file)
        material_set = ifcopenshell.api.run(
            "material.add_material_set", self.file, set_type="IfcMaterialConstituentSet"
        )
        ifcopenshell.api.run("material.add_constituent", self.file, constituent_set=material_set, material=material)
        ifcopenshell.api.run("material.assign_material", self.file, products=[wall], material=material_set)
        assert len(self.file.by_type("IfcMaterialConstituentSet")[0].MaterialConstituents) == 1
        ifcopenshell.api.run("material.remove_material", self.file, material=material)
        assert len(self.file.by_type("IfcMaterial")) == 0
        assert len(self.file.by_type("IfcRelAssociatesMaterial")) == 1
        assert self.file.by_type("IfcMaterialConstituentSet")[0].MaterialConstituents is None