Replace all ifcopenshell.api.run with ifcopenshell.api static functions.

This commit is contained in:
Dion Moult
2024-06-28 12:36:31 +10:00
parent b5d613989e
commit 07060fc769
432 changed files with 4633 additions and 4856 deletions
@@ -73,15 +73,15 @@ def add_prop_template(
.. code:: python
# Create a simple template that may be applied to all types
template = ifcopenshell.api.run("pset_template.add_pset_template", model, name="ABC_RiskFactors")
template = ifcopenshell.api.pset_template.add_pset_template(model, name="ABC_RiskFactors")
# Here's one example property
ifcopenshell.api.run("pset_template.add_prop_template", model, pset_template=template,
ifcopenshell.api.pset_template.add_prop_template(model, pset_template=template,
name="HighVoltage", description="Whether there is a risk of high voltage.",
primary_measure_type="IfcBoolean")
# Here's another
ifcopenshell.api.run("pset_template.add_prop_template", model, pset_template=template,
ifcopenshell.api.pset_template.add_prop_template(model, pset_template=template,
name="ChemicalType", description="The class of chemical spillage.",
primary_measure_type="IfcLabel")
"""
@@ -90,12 +90,12 @@ def add_pset_template(
.. code:: python
# Create a simple template that may be applied to all types
ifcopenshell.api.run("pset_template.add_pset_template", model, name="ABC_RiskFactors")
ifcopenshell.api.pset_template.add_pset_template(model, name="ABC_RiskFactors")
# Note that we aren't finished yet. Our property set template
# doesn't have any properties in it. Let's add a minimum of one
# property.
ifcopenshell.api.run("pset_template.add_prop_template", model, pset_template=template,
ifcopenshell.api.pset_template.add_prop_template(model, pset_template=template,
name="HighVoltage", description="Whether there is a risk of high voltage.",
primary_measure_type="IfcBoolean")
"""
@@ -38,13 +38,13 @@ def edit_prop_template(
.. code:: python
template = ifcopenshell.api.run("pset_template.add_pset_template", model, name="ABC_RiskFactors")
template = ifcopenshell.api.pset_template.add_pset_template(model, name="ABC_RiskFactors")
# Here's a property with just default values.
prop = ifcopenshell.api.run("pset_template.add_prop_template", model, pset_template=template)
prop = ifcopenshell.api.pset_template.add_prop_template(model, pset_template=template)
# Let's edit it to give the actual values we need.
ifcopenshell.api.run("pset_template.edit_prop_template", model,
ifcopenshell.api.pset_template.edit_prop_template(model,
prop_template=prop, attributes={"Name": "DemoA", "PrimaryMeasureType": "IfcLengthMeasure"})
"""
if enum_values := attributes.get("Enumerators", None):
@@ -39,10 +39,10 @@ def edit_pset_template(
.. code:: python
# Whoops! We named it with a buildingSMART reserved "Pset_" prefix!
template = ifcopenshell.api.run("pset_template.add_pset_template", model, name="Pset_RiskFactors")
template = ifcopenshell.api.pset_template.add_pset_template(model, name="Pset_RiskFactors")
# Let's fix it to prefix with our company code instead.
ifcopenshell.api.run("pset_template.edit_pset_template", model,
ifcopenshell.api.pset_template.edit_pset_template(model,
pset_template=template, attributes={"Name": "ABC_RiskFactors"})
"""
settings = {"pset_template": pset_template, "attributes": attributes}
@@ -35,14 +35,14 @@ def remove_prop_template(file: ifcopenshell.file, prop_template: ifcopenshell.en
.. code:: python
template = ifcopenshell.api.run("pset_template.add_pset_template", model, name="ABC_RiskFactors")
template = ifcopenshell.api.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)
prop1 = ifcopenshell.api.pset_template.add_prop_template(model, pset_template=template)
prop2 = ifcopenshell.api.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)
ifcopenshell.api.pset_template.remove_prop_template(model, prop_template=prop2)
"""
settings = {"prop_template": prop_template}
@@ -35,10 +35,10 @@ def remove_pset_template(file: ifcopenshell.file, pset_template: ifcopenshell.en
.. code:: python
# Create a template.
template = ifcopenshell.api.run("pset_template.add_pset_template", model, name="ABC_RiskFactors")
template = ifcopenshell.api.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)
ifcopenshell.api.pset_template.remove_pset_template(model, pset_template=template)
"""
settings = {"pset_template": pset_template}