Write documentation for structural API module

This commit is contained in:
Dion Moult
2023-01-03 17:32:08 +11:00
parent e53a9cd66c
commit 0c77fb81ce
21 changed files with 342 additions and 101 deletions
@@ -21,14 +21,22 @@ import ifcopenshell.api
class Usecase:
def __init__(self, file, **settings):
def __init__(self, file, product=None, structural_analysis_model=None):
"""Removes a relationship between a structural element and the analysis model
:param product: The structural element that is part of the analysis.
:type product: ifcopenshell.entity_instance.entity_instance
:param structural_analysis_model: The IfcStructuralAnalysisModel that
the structural element is related to.
:type structural_analysis_model: ifcopenshell.entity_instance.entity_instance
:return: None
:rtype: None
"""
self.file = file
self.settings = {
"product": None,
"structural_analysis_model": None,
"product": product,
"structural_analysis_model": structural_analysis_model,
}
for key, value in settings.items():
self.settings[key] = value
def execute(self):
if not self.settings["structural_analysis_model"].IsGroupedBy: