mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-10 01:41:57 +00:00
Generate functions for all API usecases for better static code features. See #2693.
This commit is contained in:
@@ -15,3 +15,5 @@
|
||||
#
|
||||
# You should have received a copy of the GNU Lesser General Public License
|
||||
# along with IfcOpenShell. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from .edit_attributes import edit_attributes
|
||||
|
||||
@@ -19,64 +19,49 @@
|
||||
import ifcopenshell.api
|
||||
|
||||
|
||||
class Usecase:
|
||||
def __init__(self, file, product=None, attributes=None):
|
||||
"""Edit the attributes of a product
|
||||
def edit_attributes(file, product=None, attributes=None) -> None:
|
||||
"""Edit the attributes of a product
|
||||
|
||||
All IFC entities have attributes. Normally they can be edited directly,
|
||||
by simply assigning a new value to them. In some scenarios, you may wish
|
||||
to also ensure that ownership history is updated. This function provides
|
||||
that convenience.
|
||||
All IFC entities have attributes. Normally they can be edited directly,
|
||||
by simply assigning a new value to them. In some scenarios, you may wish
|
||||
to also ensure that ownership history is updated. This function provides
|
||||
that convenience.
|
||||
|
||||
:param product: The product you want to edit. This may be any rooted IFC
|
||||
entity.
|
||||
:type product: ifcopenshell.entity_instance
|
||||
:param attributes: a dictionary of attribute names and values.
|
||||
:type attributes: dict, optional
|
||||
:return: None
|
||||
:rtype: None
|
||||
:param product: The product you want to edit. This may be any rooted IFC
|
||||
entity.
|
||||
:type product: ifcopenshell.entity_instance
|
||||
:param attributes: a dictionary of attribute names and values.
|
||||
:type attributes: dict, optional
|
||||
:return: None
|
||||
:rtype: None
|
||||
|
||||
Example:
|
||||
Example:
|
||||
|
||||
.. code:: python
|
||||
.. code:: python
|
||||
|
||||
element = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
|
||||
ifcopenshell.api.run("attribute.edit_attributes", model,
|
||||
product=element, attributes={"Name": "Waldo"})
|
||||
"""
|
||||
self.file = file
|
||||
self.settings = {"product": product, "attributes": attributes or {}}
|
||||
element = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
|
||||
ifcopenshell.api.run("attribute.edit_attributes", model,
|
||||
product=element, attributes={"Name": "Waldo"})
|
||||
"""
|
||||
settings = {"product": product, "attributes": attributes or {}}
|
||||
|
||||
def execute(self):
|
||||
for name, value in self.settings["attributes"].items():
|
||||
setattr(self.settings["product"], name, value)
|
||||
if hasattr(self.settings["product"], "PredefinedType"):
|
||||
if hasattr(self.settings["product"], "ElementType"):
|
||||
if (
|
||||
self.settings["product"].ElementType is None
|
||||
and self.settings["product"].PredefinedType == "USERDEFINED"
|
||||
):
|
||||
self.settings["product"].PredefinedType = "NOTDEFINED"
|
||||
elif (
|
||||
self.settings["product"].ElementType
|
||||
and self.settings["product"].PredefinedType != "USERDEFINED"
|
||||
):
|
||||
self.settings["product"].PredefinedType = "USERDEFINED"
|
||||
elif hasattr(self.settings["product"], "ObjectType"):
|
||||
relating_type = ifcopenshell.util.element.get_type(self.settings["product"])
|
||||
# Allow for None due to https://github.com/buildingSMART/IFC4.3.x-development/issues/818
|
||||
if relating_type and relating_type.PredefinedType not in ("NOTDEFINED", None):
|
||||
self.settings["product"].ObjectType = None
|
||||
self.settings["product"].PredefinedType = None
|
||||
elif (
|
||||
self.settings["product"].ObjectType is None
|
||||
and self.settings["product"].PredefinedType == "USERDEFINED"
|
||||
):
|
||||
self.settings["product"].PredefinedType = "NOTDEFINED"
|
||||
elif (
|
||||
self.settings["product"].ObjectType
|
||||
and self.settings["product"].PredefinedType != "USERDEFINED"
|
||||
):
|
||||
self.settings["product"].PredefinedType = "USERDEFINED"
|
||||
if hasattr(self.settings["product"], "OwnerHistory"):
|
||||
ifcopenshell.api.run("owner.update_owner_history", self.file, **{"element": self.settings["product"]})
|
||||
for name, value in settings["attributes"].items():
|
||||
setattr(settings["product"], name, value)
|
||||
if hasattr(settings["product"], "PredefinedType"):
|
||||
if hasattr(settings["product"], "ElementType"):
|
||||
if settings["product"].ElementType is None and settings["product"].PredefinedType == "USERDEFINED":
|
||||
settings["product"].PredefinedType = "NOTDEFINED"
|
||||
elif settings["product"].ElementType and settings["product"].PredefinedType != "USERDEFINED":
|
||||
settings["product"].PredefinedType = "USERDEFINED"
|
||||
elif hasattr(settings["product"], "ObjectType"):
|
||||
relating_type = ifcopenshell.util.element.get_type(settings["product"])
|
||||
# Allow for None due to https://github.com/buildingSMART/IFC4.3.x-development/issues/818
|
||||
if relating_type and relating_type.PredefinedType not in ("NOTDEFINED", None):
|
||||
settings["product"].ObjectType = None
|
||||
settings["product"].PredefinedType = None
|
||||
elif settings["product"].ObjectType is None and settings["product"].PredefinedType == "USERDEFINED":
|
||||
settings["product"].PredefinedType = "NOTDEFINED"
|
||||
elif settings["product"].ObjectType and settings["product"].PredefinedType != "USERDEFINED":
|
||||
settings["product"].PredefinedType = "USERDEFINED"
|
||||
if hasattr(settings["product"], "OwnerHistory"):
|
||||
ifcopenshell.api.run("owner.update_owner_history", file, **{"element": settings["product"]})
|
||||
|
||||
Reference in New Issue
Block a user