Files
IfcOpenShell/src/ifcopenshell-python/ifcopenshell/api/system/assign_system.py
T
2023-01-04 16:10:12 +11:00

103 lines
3.8 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 ifcopenshell
import ifcopenshell.api
ASSIGNABLE_DICT = {
"IfcZone": ("IfcZone", "IfcSpace", "IfcSpatialZone"),
"IfcBuiltSystem": (
"IfcBuiltElement",
"IfcFurnishingElement",
"IfcElementAssembly",
"IfcTransportElement",
),
"IfcBuildingSystem": (
"IfcBuildingElement",
"IfcFurnishingElement",
"IfcElementAssembly",
"IfcTransportElement",
),
"IfcDistributionSystem": ("IfcDistributionElement",),
"IfcStructuralAnalysisModel": ("IfcStructuralMember", "IfcStructuralConnection"),
"IfcSystem": ("IfcProduct",),
"IfcGroup": ("IfcObjectDefinition",),
}
def is_assignable(product, system) -> bool:
for assignable in ASSIGNABLE_DICT.get(system.is_a(), ()):
if product.is_a(assignable):
return True
return False
class Usecase:
def __init__(self, file, product=None, system=None):
"""Assigns a distribution element to a system
Note that it is not necessary to assign distribution ports to a system.
:param product: The IfcDistributionElement to assign to the system.
:type product: ifcopenshell.entity_instance.entity_instance
:param system: The IfcSystem you want to assign the element to.
:type system: ifcopenshell.entity_instance.entity_instance
:return: The IfcRelAssignsToGroup relationship
:rtype: ifcopenshell.entity_instance.entity_instance
Example::
# A completely empty distribution system
system = ifcopenshell.api.run("system.add_system", model)
# Create a duct
duct = ifcopenshell.api.run("root.create_entity", model,
ifc_class="IfcDuctSegment", predefined_type="RIGIDSEGMENT")
# This duct is part of the system
ifcopenshell.api.run("system.assign_system", model, product=duct, system=system)
"""
self.file = file
self.settings = {
"product": product,
"system": system,
}
def execute(self):
system = self.settings["system"]
product = self.settings["product"]
if not is_assignable(product, system):
raise TypeError(f"You cannot assign an {product.is_a()} to an {system.is_a()}")
if not self.settings["system"].IsGroupedBy:
return self.file.create_entity(
"IfcRelAssignsToGroup",
**{
"GlobalId": ifcopenshell.guid.new(),
"OwnerHistory": ifcopenshell.api.run("owner.create_owner_history", self.file),
"RelatedObjects": [self.settings["product"]],
"RelatingGroup": self.settings["system"],
},
)
rel = self.settings["system"].IsGroupedBy[0]
related_objects = set(rel.RelatedObjects) or set()
related_objects.add(self.settings["product"])
rel.RelatedObjects = list(related_objects)
ifcopenshell.api.run("owner.update_owner_history", self.file, **{"element": rel})