IfcOpenShell/src/ifcopenshell-python/ifcopenshell/api/constraint/edit_metric.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/>.


def edit_metric(file, metric=None, attributes=None) -> None:
    """Edit the attributes of a metric

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

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

    Example:

    .. code:: python

        objective = ifcopenshell.api.run("constraint.add_objective", model)
        metric = ifcopenshell.api.run("constraint.add_metric", model,
            objective=objective)
        ifcopenshell.api.run("constraint.edit_metric", model,
            metric=metric, attributes={"ConstraintGrade": "HARD"})
    """
    settings = {"metric": metric, "attributes": attributes or {}}

    for name, value in settings["attributes"].items():
        setattr(settings["metric"], name, value)