IfcOpenShell/src/ifcopenshell-python/ifcopenshell/api/document/edit_reference.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
from typing import Any, Optional


class Usecase:
    def __init__(
        self,
        file: ifcopenshell.file,
        reference: ifcopenshell.entity_instance,
        attributes: Optional[dict[str, Any]] = None,
    ):
        """Edits the attributes of an IfcDocumentReference

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

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

        Example:

        .. code:: python

            document = ifcopenshell.api.run("document.add_information", model)
            ifcopenshell.api.run("document.edit_information", model,
                information=document,
                attributes={"Identification": "A-GA-6100", "Name": "Overall Plan",
                "Location": "A-GA-6100 - Overall Plan.pdf"})
            reference = ifcopenshell.api.run("document.add_reference", model, information=document)
            ifcopenshell.api.run("document.edit_reference", model,
                reference=reference, attributes={"Identification": "2.1.15"})
        """
        self.file = file
        self.settings = {"reference": reference, "attributes": attributes or {}}

    def execute(self) -> None:
        for name, value in self.settings["attributes"].items():
            setattr(self.settings["reference"], name, value)