Write docs for unit API module

This commit is contained in:
Dion Moult
2023-01-04 16:09:39 +11:00
parent 90d4d5afda
commit fd8774718e
10 changed files with 272 additions and 40 deletions
@@ -18,11 +18,30 @@
class Usecase:
def __init__(self, file, **settings):
def __init__(self, file, unit=None, attributes=None):
"""Edits the attributes of an IfcMonetaryUnit
For more information about the attributes and data types of an
IfcMonetaryUnit, consult the IFC documentation.
:param unit: The IfcMonetaryUnit entity you want to edit
:type unit: ifcopenshell.entity_instance.entity_instance
:param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional
:return: None
:rtype: None
Example::
# If you do all your cost plans in Zimbabwean dollars then nobody
# knows how accurate the numbers are.
zwl = ifcopenshell.api.run("unit.add_monetary_unit", model, currency="ZWL")
# Ah who are we kidding
ifcopenshell.api.run("unit.edit_monetary_unit", model, unit=zwl, attributes={"Currency": "USD"})
"""
self.file = file
self.settings = {"unit": None, "attributes": {}}
for key, value in settings.items():
self.settings[key] = value
self.settings = {"unit": unit, "attributes": attributes or {}}
def execute(self):
for name, value in self.settings["attributes"].items():