ifcopenshell.api.document.edit_reference

Module Contents

ifcopenshell.api.document.edit_reference.edit_reference(file: ifcopenshell.file, reference: ifcopenshell.entity_instance, attributes: dict[str, Any] | None = None) → None

Edits the attributes of an IfcDocumentReference

For more information about the attributes and data types of an IfcDocumentReference, consult the IFC documentation.

Parameters:

• reference (ifcopenshell.entity_instance) – The IfcDocumentReference entity you want to edit

• attributes (dict, optional) – a dictionary of attribute names and values.

Returns:

None

Return type:

None

Example:

document = ifcopenshell.api.run("document.add_information", model)
ifcopenshell.api.run("document.edit_information", model,
    information=document,
    attributes={"Identification": "A-GA-6100", "Name": "Overall Plan",
    "Location": "A-GA-6100 - Overall Plan.pdf"})
reference = ifcopenshell.api.run("document.add_reference", model, information=document)
ifcopenshell.api.run("document.edit_reference", model,
    reference=reference, attributes={"Identification": "2.1.15"})