Write docs for profile API module

This commit is contained in:
Dion Moult
2022-12-14 16:49:06 +11:00
parent a5a1ef2e8e
commit a5bdcf488b
4 changed files with 91 additions and 17 deletions
@@ -18,11 +18,30 @@
class Usecase:
def __init__(self, file, **settings):
def __init__(self, file, ifc_class=None):
"""Adds a new parameterised profile
IFC offers parameterised profiles for common standardised hot roll
steel sections and common concrete forms. A full list is available on
the IFC documentation as subclasses of IfcParameterizedProfileDef.
Currently, this API has no benefit over directly calling
ifcopenshell.file.file.create_entity.
:param ifc_class: The subclass of IfcParameterizedProfileDef that you'd
like to create.
:type ifc_class: str
:return: The newly created element depending on the specified ifc_class.
:rtype: ifcopenshell.entity_instance.entity_instance
Example::
circle = ifcopenshell.api.run("profile.add_parameterized_profile", model,
ifc_class="IfcCircleProfileDef")
circle.Radius = 1.
"""
self.file = file
self.settings = {"ifc_class": None}
for key, value in settings.items():
self.settings[key] = value
self.settings = {"ifc_class": ifc_class}
def execute(self):
return self.file.create_entity(self.settings["ifc_class"])