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
@@ -21,14 +21,33 @@ import ifcopenshell.api
class Usecase:
def __init__(self, file, **settings):
def __init__(self, file, Name="Unnamed", Description=None):
"""Adds a new group
An IFC group is an arbitrary collection of products, which are typically
physical. It may be used when there is no other more specific group
which may be used. Other types of groups include distribution systems,
which group together products that are connected and circulate a medium
(such as fluid or electricity), or zones, which group together spaces,
or structural load groups, which group together loads for structural
analysis, or inventories, which are groups of assets.
:param Name: The name of the group. Defaults to "Unnamed"
:type Name: str, optional
:param Description: The description of the purpose of the group.
:type Description: str, optional
:return: The newly created IfcGroup
:rtype: ifcopenshell.entity_instance.entity_instance
Example::
ifcopenshell.api.run("group.add_group", model, Name="Unit 1A")
"""
self.file = file
self.settings = {
"Name": "Unnamed",
"Description": "",
"Name": Name or "Unnamed",
"Description": Description,
}
for key, value in settings.items():
self.settings[key] = value
def execute(self):
return self.file.create_entity(