Write documentation for pset_template API module

This commit is contained in:
Dion Moult
2022-12-16 11:22:46 +11:00
parent 0ccea3cef8
commit d2fee728f2
9 changed files with 270 additions and 57 deletions
@@ -20,9 +20,27 @@ import ifcopenshell.util.element
class Usecase:
def __init__(self, file, **settings):
def __init__(self, file, pset_template=None):
"""Removes a property set template
All property templates within the property set template are also removed
along with it.
:param pset_template: The IfcPropertySetTemplate to remove.
:type pset_template: ifcopenshell.entity_instance.entity_instance
:return: None
:rtype: None
Example::
# Create a template.
template = ifcopenshell.api.run("pset_template.add_pset_template", model, name="ABC_RiskFactors")
# Let's remove the template.
ifcopenshell.api.run("pset_template.remove_pset_template", model, pset_template=template)
"""
self.file = file
self.settings = {"pset_template": None}
self.settings = {"pset_template": pset_template}
for key, value in settings.items():
self.settings[key] = value