IfcOpenShell/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_value.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 ifcopenshell
import ifcopenshell.util.unit
import ifcopenshell.util.element


class Usecase:
    def __init__(self, file, cost_value=None, attributes=None):
        """Edits the attributes of an IfcCostValue

        For more information about the attributes and data types of an
        IfcCostValue, consult the IFC documentation.

        :param cost_value: The IfcCostValue entity you want to edit
        :type cost_value: ifcopenshell.entity_instance.entity_instance
        :param attributes: a dictionary of attribute names and values.
        :type attributes: dict, optional
        :return: None
        :rtype: None

        Example:

        .. code:: python

            schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
            item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)

            # This cost item will have a total cost of 42
            value = ifcopenshell.api.run("cost.add_cost_value", model, parent=item)
            ifcopenshell.api.run("cost.edit_cost_value", model, cost_value=value,
                attributes={"AppliedValue": 42.0})
        """
        self.file = file
        self.settings = {"cost_value": cost_value, "attributes": attributes or {}}

    def execute(self):
        for name, value in self.settings["attributes"].items():
            if name == "AppliedValue" and value is not None:
                # TODO: support all applied value select types
                value = self.file.createIfcMonetaryMeasure(value)
            elif name == "UnitBasis":
                old_unit_basis = self.settings["cost_value"].UnitBasis
                if value:
                    value_component = self.file.create_entity(
                        ifcopenshell.util.unit.get_unit_measure_class(value["UnitComponent"].UnitType),
                        value["ValueComponent"],
                    )
                    value = self.file.create_entity("IfcMeasureWithUnit", value_component, value["UnitComponent"])
                if old_unit_basis and len(self.file.get_inverse(old_unit_basis)) == 0:
                    ifcopenshell.util.element.remove_deep(self.file, old_unit_basis)
            setattr(self.settings["cost_value"], name, value)