First Commit
This commit is contained in:
@@ -0,0 +1,172 @@
|
||||
# IfcOpenShell - IFC toolkit and geometry engine
|
||||
# Copyright (C) 2021 Dion Moult <dion@thinkmoult.com>
|
||||
#
|
||||
# This file is part of IfcOpenShell.
|
||||
#
|
||||
# IfcOpenShell is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU Lesser General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# IfcOpenShell is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU Lesser General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU Lesser General Public License
|
||||
# along with IfcOpenShell. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from typing import Any, Optional
|
||||
|
||||
import ifcopenshell
|
||||
import ifcopenshell.api.owner
|
||||
import ifcopenshell.api.pset
|
||||
import ifcopenshell.guid
|
||||
|
||||
|
||||
def add_pset(
|
||||
file: ifcopenshell.file,
|
||||
product: ifcopenshell.entity_instance,
|
||||
name: str,
|
||||
ifc2x3_subclass: Optional[str] = None,
|
||||
) -> 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.
|
||||
|
||||
:param product: The IfcObject that you want to assign a property set to.
|
||||
:param name: 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.
|
||||
|
||||
In IFC2X3 should be provided as an empty string for profile properties
|
||||
(they all don't have a name property) and all material properties
|
||||
besides IfcExtendedMaterialProperties.
|
||||
:param ifc2x3_subclass: IFC2X3 subclass for material or profile properties.
|
||||
In IFC2X3 IfcProfileProperties and IfcMaterialProperties are abstract
|
||||
so you need one of their subclasses to instantiate them.
|
||||
By default, for profile will be created IfcGeneralProfileProperties
|
||||
and for material - IfcExtendedMaterialProperties.
|
||||
Will have no effect in >=IFC4.
|
||||
|
||||
:raises TypeError: If `product` class doesn't support adding a pset.
|
||||
|
||||
:return: The newly created IfcPropertySet
|
||||
|
||||
Example:
|
||||
|
||||
.. code:: python
|
||||
|
||||
# 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"})
|
||||
"""
|
||||
is_ifc2x3 = file.schema == "IFC2X3"
|
||||
|
||||
if product.is_a("IfcObject") or product.is_a("IfcContext"):
|
||||
for rel in product.IsDefinedBy or []:
|
||||
if rel.is_a("IfcRelDefinesByProperties") and rel.RelatingPropertyDefinition.Name == name:
|
||||
return rel.RelatingPropertyDefinition
|
||||
|
||||
pset = file.create_entity(
|
||||
"IfcPropertySet",
|
||||
**{
|
||||
"GlobalId": ifcopenshell.guid.new(),
|
||||
"OwnerHistory": ifcopenshell.api.owner.create_owner_history(file),
|
||||
"Name": name,
|
||||
},
|
||||
)
|
||||
ifcopenshell.api.pset.assign_pset(file, [product], pset)
|
||||
return pset
|
||||
|
||||
elif product.is_a("IfcTypeObject"):
|
||||
for definition in product.HasPropertySets or []:
|
||||
if definition.Name == name:
|
||||
return definition
|
||||
|
||||
pset = file.create_entity(
|
||||
"IfcPropertySet",
|
||||
**{
|
||||
"GlobalId": ifcopenshell.guid.new(),
|
||||
"OwnerHistory": ifcopenshell.api.owner.create_owner_history(file),
|
||||
"Name": name,
|
||||
},
|
||||
)
|
||||
ifcopenshell.api.pset.assign_pset(file, [product], pset)
|
||||
return pset
|
||||
|
||||
# in IFC2X3 IfcMaterialDefinition not yet existed
|
||||
elif product.is_a("IfcMaterialDefinition") or product.is_a("IfcMaterial"):
|
||||
kwargs: dict[str, Any]
|
||||
kwargs = {"Material": product}
|
||||
if file.schema == "IFC2X3":
|
||||
ifc_class = ifc2x3_subclass or "IfcExtendedMaterialProperties"
|
||||
definitions = (d for d in file.by_type("IfcMaterialProperties") if d.Material == product)
|
||||
if ifc_class == "IfcExtendedMaterialProperties":
|
||||
kwargs["Name"] = name
|
||||
else:
|
||||
ifc_class = "IfcMaterialProperties"
|
||||
definitions = product.HasProperties
|
||||
kwargs["Name"] = name
|
||||
for definition in definitions:
|
||||
# In IFC2X3 not all IfcMaterialProperties has Name
|
||||
if getattr(definition, "Name", None) == name:
|
||||
return definition
|
||||
|
||||
return file.create_entity(ifc_class, **kwargs)
|
||||
|
||||
elif product.is_a("IfcProfileDef"):
|
||||
# in IFC2X3 IfcProfileProperties doesn't have Name and we cannot identify them
|
||||
if file.schema != "IFC2X3":
|
||||
for definition in product.HasProperties or []:
|
||||
if definition.Name == name:
|
||||
return definition
|
||||
|
||||
kwargs = {}
|
||||
kwargs["ProfileDefinition"] = product
|
||||
if file.schema != "IFC2X3":
|
||||
kwargs["Name"] = name
|
||||
|
||||
if is_ifc2x3:
|
||||
ifc_class = ifc2x3_subclass or "IfcGeneralProfileProperties"
|
||||
else:
|
||||
ifc_class = "IfcProfileProperties"
|
||||
return file.create_entity(ifc_class, **kwargs)
|
||||
|
||||
raise TypeError(f"Class '{product.is_a(True)}' doesn't support adding a property set.")
|
||||
Reference in New Issue
Block a user