ifcopenshell.api.sequence.assign_product

Module Contents

ifcopenshell.api.sequence.assign_product.assign_product(file: ifcopenshell.file, relating_product: ifcopenshell.entity_instance, related_object: ifcopenshell.entity_instance) → ifcopenshell.entity_instance

Assigns a product to be produced as a result of a process

A construction task may result in products (e.g. a wall) being constructed. These task “Outputs” are defined in IFC through product relationships.

Not all tasks have Outputs. For example, maintenance tasks will typically not have any outputs.

See ifcopenshell.api.sequence.assign_process for Inputs and other types of process relationships that can be described in manufacturing process modeling.

Parameters:

• relating_product (ifcopenshell.entity_instance) – The IfcProduct that was constructed as a result of the task.

• related_object (ifcopenshell.entity_instance) – The IfcProcess (typically IfcTask) of the construction task.

Returns:

The newly created IfcRelAssignsToProduct relationship

Return type:

ifcopenshell.entity_instance

Example:

# Let's imagine we are creating a construction schedule. All tasks
# need to be part of a work schedule.
schedule = ifcopenshell.api.sequence.add_work_schedule(model, name="Construction Schedule A")

# Let's create a construction task. Note that the predefined type is
# important to distinguish types of tasks.
task = ifcopenshell.api.sequence.add_task(model,
    work_schedule=schedule, name="Build wall", identification="A", predefined_type="CONSTRUCTION")

# Let's say we have a wall somewhere.
wall = ifcopenshell.api.root.create_entity(model, ifc_class="IfcWall")

# Let's construct that wall!
ifcopenshell.api.sequence.assign_product(model, relating_product=wall, related_object=task)