ifcopenshell.api.resource.assign_resource

Module Contents

ifcopenshell.api.resource.assign_resource.assign_resource(file: ifcopenshell.file, relating_resource: ifcopenshell.entity_instance, related_object: ifcopenshell.entity_instance) → ifcopenshell.entity_instance

Assigns a resource to an object

Two types of objects are typically assigned to resources: products and actors.

If a product is assigned to a resource, that means that the product represents the resource on site. This may be represented via material handling zones on a construction site, or equipment like cranes and their physical locations.

If an actor is assigned to a resource, that means that the actor (person or organisation) is the actor consuming the resource (e.g. if the resource is material or equipment) or the actor performing the work (e.g. if the resource is a labour resource).

Parameters:

• relating_resource (ifcopenshell.entity_instance) – The IfcResource to assign the object to.

• related_object (ifcopenshell.entity_instance) – The IfcProduct or IfcActor to assign to the object.

Returns:

The newly created IfcRelAssignsToResource

Return type:

ifcopenshell.entity_instance

Example:

# Add our own crew
crew = ifcopenshell.api.resource.add_resource(model, ifc_class="IfcCrewResource")

# Add some a tower crane to our crew.
crane = ifcopenshell.api.resource.add_resource(model,
    parent_resource=crew, ifc_class="IfcConstructionEquipmentResource", name="Tower Crane 01")

# Our tower crane will be placed via this physical product.
product = ifcopenshell.api.root.create_entity(model,
    ifc_class="IfcBuildingElementProxy", predefined_type="CRANE")

# Let's place our crane at some X, Y coordinates.
matrix = numpy.eye(4)
matrix[0][3], matrix[1][3] = 3.0, 4.0
ifcopenshell.api.geometry.edit_object_placement(model, product=crane, matrix=matrix)

# Let's assign our crane to the resource. The crane now represents
# the resource.
ifcopenshell.api.resource.assign_resource(model, relating_resource=crane, related_object=product)

# Setup an organisation actor who will operate the crane
organisation = ifcopenshell.api.owner.add_organisation(model,
    identification="UCO", name="Unionised Crane Operators Pty Ltd")
role = ifcopenshell.api.owner.add_role(model, assigned_object=organisation, role="CREW")
actor = ifcopenshell.api.owner.add_actor(model, actor=organisation)

# This means that UCO is now our crane operator.
ifcopenshell.api.resource.assign_resource(model, relating_resource=crane, related_object=actor)