Add API documentation for group module

This commit is contained in:
Dion Moult
2022-12-06 16:42:47 +11:00
parent b34caa1b5f
commit 45953c6b49
6 changed files with 127 additions and 29 deletions
@@ -18,11 +18,24 @@
class Usecase:
def __init__(self, file, **settings):
def __init__(self, file, group=None):
"""Removes a group
All products assigned to the group will remain, but the relationship to
the group will be removed.
:param group: The IfcGroup entity you want to remove
:type group: ifcopenshell.entity_instance.entity_instance
:return: None
:rtype: None
Example::
group = ifcopenshell.api.run("group.add_group", model, Name="Unit 1A")
ifcopenshell.api.run("group.remove_group", model, group=group)
"""
self.file = file
self.settings = {"group": None}
for key, value in settings.items():
self.settings[key] = value
self.settings = {"group": group}
def execute(self):
for rel in self.settings["group"].IsGroupedBy or []: