Glassvision/IfcOpenShell
1
0
Fork 0
mirror of https://github.com/IfcOpenShell/IfcOpenShell.git synced 2026-08-10 09:48:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Write documentation for pset_template API module

Browse Source
This commit is contained in:
Dion Moult
2022-12-16 11:22:46 +11:00
parent 0ccea3cef8
commit d2fee728f2
9 changed files with 270 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ifcopenshell-python/ifcopenshell/api/pset/edit_pset.py
+6 -9
View File
@@ -112,23 +112,20 @@ class Usecase:
# own "Company Standard" property set templates. Notice how we
# prefix our property set with "Foo_", if our company name was "Foo"
# this would make sense.
pset_template = ifcopenshell.api.run("pset_template.add_pset_template", model)
ifcopenshell.api.run("pset_template.edit_pset_template", model, attributes={"Name": "Foo_Bar"})
template = ifcopenshell.api.run("pset_template.add_pset_template", model, name="Foo_bar")
# Let's imagine we want all model authors to specify two properties,
# one being a length measurement and another being a boolean.
prop1 = ifcopenshell.api.run("pset_template.add_prop_template", model, pset_template=pset_template)
ifcopenshell.api.run("pset_template.edit_prop_template", model,
prop_template=prop1, attributes={"Name": "DemoA", "PrimaryMeasureType": "IfcLengthMeasure"})
prop2 = ifcopenshell.api.run("pset_template.add_prop_template", model, pset_template=pset_template)
ifcopenshell.api.run("pset_template.edit_prop_template", model,
prop_template=prop2, attributes={"Name": "DemoB", "PrimaryMeasureType": "IfcBoolean"})
prop1 = ifcopenshell.api.run("pset_template.add_prop_template", model,
pset_template=template, name="DemoA", primary_measure_type="IfcLengthMeasure")
prop2 = ifcopenshell.api.run("pset_template.add_prop_template", model,
pset_template=template, name="DemoB", primary_measure_type="IfcBoolean")
# Now we can use our property set template to add our properties,
# and the data types will always match our template.
pset = ifcopenshell.api.run("pset.add_pset", model, product=wall_type, name="Foo_Bar")
ifcopenshell.api.run("pset.edit_pset", model,
pset=pset, properties={"DemoA": 42.3, "DemoB": True}, pset_template=pset_template)
pset=pset, properties={"DemoA": 42.3, "DemoB": True}, pset_template=template)
# Here's a third scenario where we want to add arbitrary properties
# that are not standardised by anything, not even our own custom
src/ifcopenshell-python/ifcopenshell/api/pset/edit_qto.py
+5 -12
View File
@@ -78,25 +78,19 @@ class Usecase:
# prefix our property set with "Foo_", if our company name was "Foo"
# this would make sense. In this example, we say that our template
# only applies to walls and is for quantities.
pset_template = ifcopenshell.api.run("pset_template.add_pset_template", model)
ifcopenshell.api.run("pset_template.edit_pset_template", model,
attributes={
"Name": "Foo_Wall", "TemplateType": "QTO_OCCURRENCEDRIVEN", "ApplicableEntity": "IfcWall"
})
template = ifcopenshell.api.run("pset_template.add_pset_template", model,
name="Foo_Wall", template_type="QTO_OCCURRENCEDRIVEN", applicable_entity="IfcWall")
# Let's imagine we want all model authors to specify a length
# measurement for the portion of a wall that is overhanging.
prop = ifcopenshell.api.run("pset_template.add_prop_template", model, pset_template=pset_template)
ifcopenshell.api.run("pset_template.edit_prop_template", model,
prop_template=prop, attributes={
"Name": "OverhangLength", "TemplateType": "Q_LENGTH", "PrimaryMeasureType": "IfcLengthMeasure"
})
prop = ifcopenshell.api.run("pset_template.add_prop_template", model, pset_template=template,
name="OverhangLength", template_type="Q_LENGTH", primary_measure_type="IfcLengthMeasure")
# Now we can use our property set template to add our properties,
# and the data types will always match our template.
qto = ifcopenshell.api.run("pset.add_qto", model, product=wall, name="Foo_Wall")
ifcopenshell.api.run("pset.edit_qto", model,
qto=qto, properties={"OverhangLength": 42.3}, pset_template=pset_template)
qto=qto, properties={"OverhangLength": 42.3}, pset_template=template)
# Here's a third scenario where we want to add arbitrary quantities
# that are not standardised by anything, not even our own custom
@@ -112,7 +106,6 @@ class Usecase:
# if possible. So this will still be a length measure.
ifcopenshell.api.run("pset.edit_qto", model, qto=qto, properties={"SomeLength": 12.3})
"""
self.file = file
self.settings = {"qto": qto, "name": name, "properties": properties or {}, "pset_template": pset_template}