mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-10 09:48:32 +00:00
Dion Moult
103 lines
4.7 KiB
Python
103 lines
4.7 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
|
|
|
|
|
|
class Usecase:
|
|
def __init__(self, file, relating_actor=None, related_object=None):
|
|
"""Assigns an actor to an object
|
|
|
|
An actor may be assigned to objects which implies that the actor is
|
|
responsible for. This is most commonly used in facility management for
|
|
indicating the manufacturers, suppliers, and warrantors for product
|
|
types.
|
|
|
|
Here are a list of objects you may assign an actor to:
|
|
|
|
- IfcControl: Indicates project directives issued by the actor.
|
|
- IfcGroup: Indicates groups for which the actor is responsible.
|
|
- IfcProduct: Indicates products for which the actor is responsible.
|
|
- IfcProcess: Indicates processes for which the actor is responsible.
|
|
- IfcResource: Indicates resources for which the actor is responsible.
|
|
|
|
:param relating_actor: The IfcActor who is responsible for the object.
|
|
:type relating_actor: ifcopenshell.entity_instance.entity_instance
|
|
:param related_object: The object the actor is responsible for.
|
|
:type related_object: ifcopenshell.entity_instance.entity_instance
|
|
:return: The newly created IfcRelAssignsToActor relationship.
|
|
:rtype: ifcopenshell.entity_instance.entity_instance
|
|
|
|
Example::
|
|
|
|
# We need to procure and install 2 of this particular pump type in our facility.
|
|
pump_type = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcPumpType")
|
|
|
|
# Define who the manufacturer is
|
|
manufacturer = ifcopenshell.api.run("owner.add_organisation", model,
|
|
identification="PWP", name="Pumps With Power")
|
|
ifcopenshell.api.run("owner.add_role", model, assigned_object=manufacturer, role="MANUFACTURER")
|
|
|
|
# To help our facility manager, it's nice to provide contact details
|
|
# of the manufacturer so they know how to call when the pump breaks.
|
|
telecom = ifcopenshell.api.run("owner.add_address", model,
|
|
assigned_object=organisation, ifc_class="IfcTelecomAddress")
|
|
ifcopenshell.api.run("owner.edit_address", model, address=telecom,
|
|
attributes={"Purpose": "OFFICE", "TelephoneNumbers": ["+61432466949"],
|
|
"ElectronicMailAddresses": ["contact@example.com"],
|
|
"WWWHomePageURL": "https://example.com"})
|
|
|
|
# Make the manufacturer responsible for that pump type.
|
|
ifcopenshell.api.run("owner.assign_actor", model,
|
|
relating_actor=manufacturer, related_object=pump_type)
|
|
"""
|
|
self.file = file
|
|
self.settings = {
|
|
"relating_actor": relating_actor,
|
|
"related_object": related_object,
|
|
}
|
|
|
|
def execute(self):
|
|
if self.settings["related_object"].HasAssignments:
|
|
for rel in self.settings["related_object"].HasAssignments:
|
|
if rel.is_a("IfcRelAssignsToActor") and rel.RelatingActor == self.settings["relating_actor"]:
|
|
return
|
|
|
|
rel = None
|
|
|
|
if self.settings["relating_actor"].IsActingUpon:
|
|
rel = self.settings["relating_actor"].IsActingUpon[0]
|
|
|
|
if rel:
|
|
related_objects = list(rel.RelatedObjects)
|
|
related_objects.append(self.settings["related_object"])
|
|
rel.RelatedObjects = related_objects
|
|
ifcopenshell.api.run("owner.update_owner_history", self.file, **{"element": rel})
|
|
else:
|
|
rel = self.file.create_entity(
|
|
"IfcRelAssignsToActor",
|
|
**{
|
|
"GlobalId": ifcopenshell.guid.new(),
|
|
"OwnerHistory": ifcopenshell.api.run("owner.create_owner_history", self.file),
|
|
"RelatedObjects": [self.settings["related_object"]],
|
|
"RelatingActor": self.settings["relating_actor"],
|
|
}
|
|
)
|
|
return rel
|