ifcopenshell.api.pset.add_pset

Module Contents

ifcopenshell.api.pset.add_pset.add_pset(file: ifcopenshell.file, product: ifcopenshell.entity_instance, name: str) → ifcopenshell.entity_instance

Adds a new property set to a product

Products, such as physical objects or types in IFC may have properties associated with them. These properties are typically simple key value metadata with data types. For example, a wall type may have a property called FireRating with a text value of “2HR”. Properties are grouped into property sets, so that related properties are grouped together.

If a property is assigned to a type, the property is inherited by all occurrences of that type. For example, a wall type with a FireRating property of “2HR” automatically implies that all walls of that wall type also have a FireRating of “2HR”. It is not necessary to explictly define the property again for each occurrence. This also means that properties are typically defined on types. If the same property is defined at an occurrence, this overrides the property defined on the type.

buildingSMART has come up with a long list of standardised properties for the most common properties required internationally. This solves the age-old question of “where do I store my FireRating data for walls”? The answer, in this case, is in the “FireRating” property with an “IfcLabel” data type grouped in the “Pset_WallCommon” property set. It is recommended to view the list of standardised buildingSMART properties and see if any suit your needs first. If none are appropriate, then you are free to create your own custom properties.

This function adds a blank named property set. One you have a property set you may add properties using ifcopenshell.api.pset.edit_pset.

See also ifcopenshell.api.pset.add_qto if you want to add quantification data, rather than arbitrary metadata.

Parameters:

• product (ifcopenshell.entity_instance) – The IfcObject that you want to assign a property set to.

• name (str) – The name of the property set. Property sets that are standardised by buildingSMART typically have a prefix of “Pset_”, like “Pset_WallCommon”. If you create your own, you must not use that prefix. It is recommended to use your own prefix tailored to your project, company, or local government requirement.

Raises:

TypeError – If product class doesn’t support adding a pset.

Returns:

The newly created IfcPropertySet

Return type:

ifcopenshell.entity_instance

Example:

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

# Note that this only creates and assigns an empty property set. We
# still need to add properties into the property set. Having blank
# property sets are invalid.
pset = ifcopenshell.api.pset.add_pset(model, product=wall_type, name="Pset_WallCommon")

# Add a fire rating property standardised by buildingSMART.
ifcopenshell.api.pset.edit_pset(model, pset=pset, properties={"FireRating": "2HR"})