Write docs for owner API module

This commit is contained in:
Dion Moult
2022-12-14 15:58:31 +11:00
parent 05cd11ae12
commit a5a1ef2e8e
24 changed files with 696 additions and 103 deletions
@@ -20,11 +20,25 @@ import ifcopenshell.api
class Usecase:
def __init__(self, file, **settings):
def __init__(self, file, organisation=None):
"""Remove an organisation
All roles and addresses assigned to the organisation will also be
removed.
:param organisation: The IfcOrganization to remove
:type organisation: ifcopenshell.entity_instance.entity_instance
:return: None
:rtype: None
Example::
organisation = ifcopenshell.api.run("owner.add_organisation", model,
identification="AWB", name="Architects Without Ballpens")
ifcopenshell.api.run("owner.remove_organisation", model, organisation=organisation)
"""
self.file = file
self.settings = {"organisation": None}
for key, value in settings.items():
self.settings[key] = value
self.settings = {"organisation": organisation}
def execute(self):
for role in self.settings["organisation"].Roles or []: