Generate functions for all API usecases for better static code features. See #2693.

This commit is contained in:
Dion Moult
2024-05-06 14:35:39 +10:00
parent 10f894e2ea
commit d11ec67129
330 changed files with 13283 additions and 13751 deletions
@@ -19,41 +19,38 @@
import ifcopenshell.util.element
class Usecase:
def __init__(self, file, prop_template=None):
"""Removes a property template
def remove_prop_template(file, prop_template=None) -> None:
"""Removes a property template
Note that a property set template should always have at least one
property template to be valid, so take care when removing property
templates.
Note that a property set template should always have at least one
property template to be valid, so take care when removing property
templates.
:param prop_template: The IfcSimplePropertyTemplate to remove.
:type prop_template: ifcopenshell.entity_instance
:return: None
:rtype: None
:param prop_template: The IfcSimplePropertyTemplate to remove.
:type prop_template: ifcopenshell.entity_instance
:return: None
:rtype: None
Example:
Example:
.. code:: python
.. code:: python
template = ifcopenshell.api.run("pset_template.add_pset_template", model, name="ABC_RiskFactors")
template = ifcopenshell.api.run("pset_template.add_pset_template", model, name="ABC_RiskFactors")
# Here's two propertes with just default values.
prop1 = ifcopenshell.api.run("pset_template.add_prop_template", model, pset_template=template)
prop2 = ifcopenshell.api.run("pset_template.add_prop_template", model, pset_template=template)
# Here's two propertes with just default values.
prop1 = ifcopenshell.api.run("pset_template.add_prop_template", model, pset_template=template)
prop2 = ifcopenshell.api.run("pset_template.add_prop_template", model, pset_template=template)
# Let's remove the second one.
ifcopenshell.api.run("pset_template.remove_prop_template", model, prop_template=prop2)
"""
self.file = file
self.settings = {"prop_template": prop_template}
# Let's remove the second one.
ifcopenshell.api.run("pset_template.remove_prop_template", model, prop_template=prop2)
"""
settings = {"prop_template": prop_template}
def execute(self):
for inverse in self.file.get_inverse(self.settings["prop_template"]):
if len(inverse.HasPropertyTemplates) == 1:
inverse.HasPropertyTemplates = []
else:
has_property_templates = list(inverse.HasPropertyTemplates)
has_property_templates.remove(self.settings["prop_template"])
inverse.HasPropertyTemplates = has_property_templates
ifcopenshell.util.element.remove_deep(self.file, self.settings["prop_template"])
for inverse in file.get_inverse(settings["prop_template"]):
if len(inverse.HasPropertyTemplates) == 1:
inverse.HasPropertyTemplates = []
else:
has_property_templates = list(inverse.HasPropertyTemplates)
has_property_templates.remove(settings["prop_template"])
inverse.HasPropertyTemplates = has_property_templates
ifcopenshell.util.element.remove_deep(file, settings["prop_template"])