ifcopenshell.api.void.remove_opening

Module Contents

ifcopenshell.api.void.remove_opening.remove_opening(file: ifcopenshell.entity_instance, opening: ifcopenshell.entity_instance) → None

Remove an opening

Fillings are retained as orphans. Voided elements remain. Openings cannot exist by themselves, so not only is the opening relationship removed, the opening is also removed.

Parameters:

opening (ifcopenshell.entity_instance) – The IfcOpeningElement to remove.

Returns:

None

Return type:

None

Example:

# Create an oprhaned opening. Note that an orphaned opening is
# invalid, as an opening can only exist when voiding another
# element.
opening = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcOpeningElement")

# Remove it. This brings us back to a valid model.
ifcopenshell.api.run("void.remove_opening", model, opening=opening)