mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-12 10:33:20 +00:00
Dion Moult
94 lines
3.5 KiB
Python
94 lines
3.5 KiB
Python
# 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 time
|
|
import ifcopenshell
|
|
import ifcopenshell.api
|
|
import ifcopenshell.api.owner.settings
|
|
import ifcopenshell.util.element
|
|
from typing import Union
|
|
|
|
|
|
def update_owner_history(
|
|
file: ifcopenshell.file, element: ifcopenshell.entity_instance
|
|
) -> Union[ifcopenshell.entity_instance, None]:
|
|
"""Updates the owner that is assigned to an object
|
|
|
|
This ensures that the owner is tracked to have modified the object last,
|
|
including the time when the change occured. See
|
|
ifcopenshell.api.owner.create_owner_history for details.
|
|
|
|
:param element: The IfcRoot element to update the ownership details on
|
|
when a change is made.
|
|
:type element: ifcopenshell.entity_instance
|
|
:return: The updated IfcOwnerHistory element.
|
|
:rtype: ifcopenshell.entity_instance
|
|
|
|
Example:
|
|
|
|
.. code:: python
|
|
|
|
# See ifcopenshell.api.owner.create_owner_history for setup
|
|
# [ ... example setup code ... ]
|
|
|
|
# We've finished our ownership setup. Now let's start our script and
|
|
# create a space. Notice we don't actually call
|
|
# create_owner_history at all. This is already automatically handled
|
|
# by the API when necessary. Under the hood, the API is actually
|
|
# running this code on the IfcSpace element:
|
|
# element.OwnerHistory = ifcopenshell.api.run("owner.create_owner_history", model)
|
|
space = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcSpace")
|
|
|
|
# Any edits we make will have ownership tracking automatically
|
|
# applied. There is no need to run any owner.update_owner_history
|
|
# API calls either.
|
|
ifcopenshell.api.run("attribute.edit_attributes", model, product=space, attributes={"Name": "Lobby"})
|
|
"""
|
|
settings = {"element": element}
|
|
|
|
element = settings["element"]
|
|
if not element.is_a("IfcRoot"):
|
|
return
|
|
user = ifcopenshell.api.owner.settings.get_user(file)
|
|
if not user:
|
|
return
|
|
application = ifcopenshell.api.owner.settings.get_application(file)
|
|
if not application:
|
|
return
|
|
|
|
# 1 IfcRoot IfcOwnerHistory
|
|
owner_history = element[1]
|
|
if not owner_history:
|
|
owner_history = ifcopenshell.api.run("owner.create_owner_history", file)
|
|
element[1] = owner_history
|
|
return owner_history
|
|
|
|
if file.get_total_inverses(owner_history) > 1:
|
|
owner_history = ifcopenshell.util.element.copy(file, owner_history)
|
|
element[1] = owner_history
|
|
|
|
# 3 IfcOwnerHistory ChangeAction
|
|
owner_history[3] = "MODIFIED"
|
|
# 4 IfcOwnerHistory LastModifiedDate
|
|
owner_history[4] = int(time.time())
|
|
# 5 IfcOwnerHistory LastModifyingUser
|
|
owner_history[5] = user
|
|
# 6 IfcOwnerHistory LastModifyingApplication
|
|
owner_history[6] = application
|
|
return owner_history
|