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
@@ -17,34 +17,31 @@
# along with IfcOpenShell. If not, see <http://www.gnu.org/licenses/>.
class Usecase:
def __init__(self, file, system=None, attributes=None):
"""Edits the attributes of an IfcSystem
def edit_system(file, system=None, attributes=None) -> None:
"""Edits the attributes of an IfcSystem
For more information about the attributes and data types of an
IfcSystem, consult the IFC documentation.
For more information about the attributes and data types of an
IfcSystem, consult the IFC documentation.
:param system: The IfcSystem entity you want to edit
:type system: ifcopenshell.entity_instance
:param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional
:return: None
:rtype: None
:param system: The IfcSystem entity you want to edit
:type system: ifcopenshell.entity_instance
:param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional
:return: None
:rtype: None
Example:
Example:
.. code:: python
.. code:: python
# A completely empty distribution system
system = ifcopenshell.api.run("system.add_system", model)
# A completely empty distribution system
system = ifcopenshell.api.run("system.add_system", model)
# Change the name of the system to "HW" for Hot Water
ifcopenshell.api.run("system.edit_system", model, system=system, attributes={"Name": "HW"})
"""
# Change the name of the system to "HW" for Hot Water
ifcopenshell.api.run("system.edit_system", model, system=system, attributes={"Name": "HW"})
"""
self.file = file
self.settings = {"system": system, "attributes": attributes or {}}
settings = {"system": system, "attributes": attributes or {}}
def execute(self):
for name, value in self.settings["attributes"].items():
setattr(self.settings["system"], name, value)
for name, value in settings["attributes"].items():
setattr(settings["system"], name, value)