ifcopenshell.api.system.unassign_flow_control

Module Contents

ifcopenshell.api.system.unassign_flow_control.unassign_flow_control(file, relating_flow_element=None, related_flow_control=None) → None

Unassigns flow control element from the flow element.

Parameters:

• related_flow_control (ifcopenshell.entity_instance) – IfcDistributionControlElement controling the flow element

• relating_flow_element (ifcopenshell.entity_instance) – The IfcDistributionFlowElement that is being controlled

Returns:

If the control still is related to other objects, the IfcRelFlowControlElements is returned, otherwise None.

Return type:

ifcopenshell.entity_instance, None

Example:

# assign control to the flow element
flow_element = file.createIfcFlowSegment()
flow_control = file.createIfcController()
relation = ifcopenshell.api.run(
    "system.assign_flow_control", file,
    relating_control=flow_control, related_object=flow_element
)

# und unassign it
ifcopenshell.api.run("system.unassign_flow_control", file,
    relating_control=flow_control, related_object=flow_element
)