IfcOpenShell/src/ifcopenshell-python/test/api/unit/test_edit_named_unit.py

# IfcOpenShell - IFC toolkit and geometry engine
# Copyright (C) 2021 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.unit


class TestEditNamedUnitIFC2X3(test.bootstrap.IFC2X3):
    def test_edit_context_dependent_unit(self):
        unit = self.file.createIfcContextDependentUnit()
        unit.Dimensions = self.file.createIfcDimensionalExponents()
        ifcopenshell.api.unit.edit_named_unit(
            self.file,
            unit=unit,
            attributes={"Dimensions": (1, 2, 3, 4, 5, 6, 7), "UnitType": "LENGTHUNIT", "Name": "Name"},
        )
        assert [a for a in unit.Dimensions] == [1, 2, 3, 4, 5, 6, 7]
        assert unit.UnitType == "LENGTHUNIT"
        assert unit.Name == "Name"

    def test_edit_si_unit(self):
        unit = self.file.createIfcSIUnit()
        ifcopenshell.api.unit.edit_named_unit(
            self.file,
            unit=unit,
            attributes={"UnitType": "LENGTHUNIT", "Prefix": "MILLI", "Name": "METRE"},
        )
        assert unit.UnitType == "LENGTHUNIT"
        assert unit.Prefix == "MILLI"
        assert unit.Name == "METRE"

    def test_edit_conversion_based_unit(self):
        unit = self.file.createIfcConversionBasedUnit()
        unit.Dimensions = self.file.createIfcDimensionalExponents()
        ifcopenshell.api.unit.edit_named_unit(
            self.file,
            unit=unit,
            attributes={"Dimensions": (1, 2, 3, 4, 5, 6, 7), "UnitType": "LENGTHUNIT", "Name": "Name"},
        )
        assert [a for a in unit.Dimensions] == [1, 2, 3, 4, 5, 6, 7]
        assert unit.UnitType == "LENGTHUNIT"
        assert unit.Name == "Name"


class TestEditNamedUnitIFC4(test.bootstrap.IFC4, TestEditNamedUnitIFC2X3):
    def test_edit_conversion_based_unit_with_offset(self):
        unit = self.file.createIfcConversionBasedUnitWithOffset()
        unit.Dimensions = self.file.createIfcDimensionalExponents()
        ifcopenshell.api.unit.edit_named_unit(
            self.file,
            unit=unit,
            attributes={
                "Dimensions": (1, 2, 3, 4, 5, 6, 7),
                "UnitType": "LENGTHUNIT",
                "Name": "Name",
                "ConversionOffset": 1,
            },
        )
        assert [a for a in unit.Dimensions] == [1, 2, 3, 4, 5, 6, 7]
        assert unit.UnitType == "LENGTHUNIT"
        assert unit.Name == "Name"
        assert unit.ConversionOffset == 1