Module Contents

class ifcopenshell.api.pset.edit_pset.Usecase
add_new_properties() list[ifcopenshell.entity_instance]
assign_new_properties(props: ifcopenshell.entity_instance) None
cast_value_to_primary_measure_type(value, primary_measure_type)
execute() None
get_primary_measure_type(name, old_value=None, new_value=None)
get_properties() list[ifcopenshell.entity_instance]

Returns list of existing properties

load_pset_template() None
static unpack_unit_value(value_candidate)

Returns tuple of the format: (Unit, NominalValue) NOTE: Unit fallbacks to None

update_existing_prop_enum(prop: ifcopenshell.entity_instance) ifcopenshell.entity_instance | None

NOTE: Assumes the prop exists

update_existing_prop_single_value(prop: ifcopenshell.entity_instance) ifcopenshell.entity_instance | None

NOTE: Assumes the prop exists

update_existing_properties() list[ifcopenshell.entity_instance]
update_pset_name() None
ifcopenshell.api.pset.edit_pset.edit_pset(file: ifcopenshell.entity_instance, pset: ifcopenshell.entity_instance, name: str | None = None, properties: dict[str, Any] | None = None, pset_template: ifcopenshell.entity_instance | None = None, should_purge: bool = False) None

Edits a property set and its properties

At its simplest usage, this may be used to edit the name of a property set. It may also be used to add, edit, or remove properties, either arbitrarily or using a property set template.

A list of properties are provided as a dictionary, where the keys are property names, and values are property values. Keys that don’t already exist are interpreted as properties to be added. Keys that already exist are interpreted as properties to be edited. A “None” value may specify a property to be deleted.

Properties must have a data type. There are lots of data types in IFCs, not just simple unitless data types like integers, booleans, text, but also distinguishing between types of text, like labels versus descriptive text. There are also lots of unit-based data types like areas, volumes, lengths, power, density, flow rates, pressure, etc.

To ensure the appropriate data type is used for properties, a property set template may be used. These can be seen as “property specifications”. A default selection is provided by buildingSMART, so that all buildingSMART defined standard properties have exactly the same data types and exactly the right property names without fear of invalid data or typos. The built-in buildingSMART templates are always loaded. However, you may also specify your own templates. If you try to add a non-standard property that does not exist in either your own template or in the built-in buildingSMART template, then you have the responsibility to ensure that data types are always consistent and correct.

  • pset (ifcopenshell.entity_instance) – The IfcPropertySet to edit.

  • name (str, optional) – A new name for the property set. If no name is specified, the property set name is not changed.

  • properties (dict) – A dictionary of properties. The keys must be a string of the name of the property. The data type of the value will be determined by the property set template. If no property set template is found, the data types of the Python values will influence the IFC data type of the property. String values will become IfcLabel, float values will become IfcReal, booleans will become IfcBoolean, and integers will become IfcInteger. If more control is desired, you may explicitly specify IFC data objects directly. Note that provided properties might be mutated in the process.

  • pset_template (ifcopenshell.entity_instance, optional) – If a property set template is provided, this will be used to determine data types. If no user-defined template is provided, the built-in buildingSMART templates will be loaded.

  • should_purge (bool, optional) – If left as False, properties set to None will be left as None but not removed. If set to true, properties set to None will actually be removed.



Return type:



# Let's imagine we have a new wall type.
wall_type = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWallType")

# This is a standard buildingSMART property set.
pset = ifcopenshell.api.run("pset.add_pset", model, product=wall_type, name="Pset_WallCommon")

# In this scenario, we don't specify any pset_template because it is
# part of the built-in buildingSMART templates, and so the
# FireRating will automatically be an IfcLabel, and the thermal
# transmittance value will automatically be an
# IfcThermalTransmittanceMeasure. Neither of these properties exist
# yet, so they will be created.
ifcopenshell.api.run("pset.edit_pset", model,
    pset=pset, properties={"FireRating": "2HR", "ThermalTransmittance": 42.3})

# We can edit existing properties. In this case, "FireRating" is
# edited from "2HR" to "1HR". Combustible is new, and will be added.
# The existing "ThermalTransmittance" property will be left
# unchanged.
ifcopenshell.api.run("pset.edit_pset", model,
    pset=pset, properties={"FireRating": "1HR", "Combustible": False})

# Setting to None will change the value but not delete the property.
ifcopenshell.api.run("pset.edit_pset", model, pset=pset, properties={"Combustible": None})

# If you actually want to delete the property, enable purging.
ifcopenshell.api.run("pset.edit_pset", model, pset=pset,
    properties={"Combustible": None}, should_purge=True)

# What if we wanted to manage our own properties? Let's create our
# own "Company Standard" property set templates. Notice how we
# prefix our property set with "Foo_", if our company name was "Foo"
# this would make sense.
template = ifcopenshell.api.run("pset_template.add_pset_template", model, name="Foo_bar")

# Let's imagine we want all model authors to specify two properties,
# one being a length measurement and another being a boolean.
prop1 = ifcopenshell.api.run("pset_template.add_prop_template", model,
    pset_template=template, name="DemoA", primary_measure_type="IfcLengthMeasure")
prop2 = ifcopenshell.api.run("pset_template.add_prop_template", model,
    pset_template=template, name="DemoB", primary_measure_type="IfcBoolean")

# Now we can use our property set template to add our properties,
# and the data types will always match our template.
pset = ifcopenshell.api.run("pset.add_pset", model, product=wall_type, name="Foo_Bar")
ifcopenshell.api.run("pset.edit_pset", model,
    pset=pset, properties={"DemoA": 42.3, "DemoB": True}, pset_template=template)

# Here's a third scenario where we want to add arbitrary properties
# that are not standardised by anything, not even our own custom
# templates.
pset = ifcopenshell.api.run("pset.add_pset", model, product=wall_type, name="Custom_Pset")
ifcopenshell.api.run("pset.edit_pset", model,
    pset=pset, properties={
        # Basic Python data types are mapped to a sensible default
        "SomeLabel": "Foo",
        "SomeNumber": 12.3,
        # But we can always specify exactly what we're after too
        "ExplicitLength": model.createIfcLengthMeasure(42.3)

# Editing existing properties will retain their current data types
# if possible. So this will still be a length measure.
ifcopenshell.api.run("pset.edit_pset", model, pset=pset, properties={"ExplicitLength": 12.3})