mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-10 17:58:20 +00:00
Write documentation for pset_template API module
This commit is contained in:
Dion Moult
@@ -20,22 +20,89 @@ import ifcopenshell
|
||||
|
||||
|
||||
class Usecase:
|
||||
def __init__(self, file, **settings):
|
||||
def __init__(
|
||||
self,
|
||||
file,
|
||||
pset_template=None,
|
||||
name="NewProperty",
|
||||
description=None,
|
||||
template_type="P_SINGLEVALUE",
|
||||
primary_measure_type="IfcLabel",
|
||||
):
|
||||
"""Adds new property templates to a property set template
|
||||
|
||||
Assuming you first have a property set template, this allows you to add
|
||||
templates for properties within that property set. A property template
|
||||
lets you specify the name, description, and data type of a property.
|
||||
When the template is provided to a model author, this gives them clear
|
||||
instructions about the intention of the property and exactly which data
|
||||
type to use.
|
||||
|
||||
Types of properties and quantities include:
|
||||
|
||||
* P_SINGLEVALUE - a single value, the most common type of property.
|
||||
* P_ENUMERATEDVALUE - the property value may one or more values chosen
|
||||
from a preset list of values.
|
||||
* P_BOUNDEDVALUE - the property has a minimum, maximum, and set value.
|
||||
* P_LISTVALUE - the property has a list of values.
|
||||
* P_TABLEVALUE - the property has a table of values.
|
||||
* P_REFERENCEVALUE - the property is a parametric reference to another
|
||||
value. This is only for advanced users.
|
||||
* Q_LENGTH - the quantity is a length.
|
||||
* Q_AREA - the quantity is an area.
|
||||
* Q_VOLUME - the quantity is a volume.
|
||||
* Q_COUNT - the quantity is counting a item.
|
||||
* Q_WEIGHT - the quantity is a weight.
|
||||
* Q_TIME - the quantity is a time duration.
|
||||
|
||||
:param pset_template: The property set template to add the property
|
||||
template to.
|
||||
:type pset_template: ifcopenshell.entity_instance.entity_instance
|
||||
:param name: The name of the property
|
||||
:type name: str,optional
|
||||
:param description: A few words describing what the property stores.
|
||||
:type description: str,optional
|
||||
:param primary_measure_type: The data type of the property. Consult the
|
||||
IFC documentation for the full list of data types.
|
||||
:param primary_measure_type: str,optional
|
||||
:return: The newly created IfcSimplePropertyTemplate.
|
||||
:rtype: ifcopenshell.entity_instance.entity_instance
|
||||
|
||||
Example::
|
||||
|
||||
# Create a simple template that may be applied to all types
|
||||
template = ifcopenshell.api.run("pset_template.add_pset_template", model, name="ABC_RiskFactors")
|
||||
|
||||
# Here's one example property
|
||||
ifcopenshell.api.run("pset_template.add_prop_template", model, pset_template=template,
|
||||
name="HighVoltage", description="Whether there is a risk of high voltage.",
|
||||
primary_measure_type="IfcBoolean")
|
||||
|
||||
# Here's another
|
||||
ifcopenshell.api.run("pset_template.add_prop_template", model, pset_template=template,
|
||||
name="ChemicalType", description="The class of chemical spillage.",
|
||||
primary_measure_type="IfcLabel")
|
||||
"""
|
||||
self.file = file
|
||||
self.settings = {"pset_template": None}
|
||||
for key, value in settings.items():
|
||||
self.settings[key] = value
|
||||
self.settings = {
|
||||
"pset_template": pset_template,
|
||||
"name": name,
|
||||
"description": description,
|
||||
"template_type": template_type,
|
||||
"primary_measure_type": primary_measure_type,
|
||||
}
|
||||
|
||||
def execute(self):
|
||||
prop_template = self.file.create_entity(
|
||||
"IfcSimplePropertyTemplate",
|
||||
**{
|
||||
"GlobalId": ifcopenshell.guid.new(),
|
||||
"Name": "NewProperty",
|
||||
"PrimaryMeasureType": "IfcLabel",
|
||||
"TemplateType": "P_SINGLEVALUE",
|
||||
"Name": self.settings["name"],
|
||||
"Description": self.settings["description"],
|
||||
"PrimaryMeasureType": self.settings["primary_measure_type"],
|
||||
"TemplateType": self.settings["template_type"],
|
||||
"AccessState": "READWRITE",
|
||||
"Enumerators": None
|
||||
"Enumerators": None,
|
||||
}
|
||||
)
|
||||
has_property_templates = list(self.settings["pset_template"].HasPropertyTemplates or [])
|
||||
|
||||
@@ -20,19 +20,88 @@ import ifcopenshell
|
||||
|
||||
|
||||
class Usecase:
|
||||
def __init__(self, file, **settings):
|
||||
def __init__(
|
||||
self, file, name="New_Pset", template_type="PSET_TYPEDRIVENOVERRIDE", applicable_entity="IfcTypeObject"
|
||||
):
|
||||
"""Adds a new property set template
|
||||
|
||||
This creates a new template for property sets. A template defines what
|
||||
the name of the property set should be, what properties it can have,
|
||||
what entities (e.g. wall) the property set can be assigned to, whether
|
||||
it should be assigned at a type or occurrence level, the data types of
|
||||
the properties, and descriptions of the properties. This template can
|
||||
then be used as a project, company, or local government standard.
|
||||
|
||||
buildingSMART itself ships a catalogue of property sets using these
|
||||
templates, ensuring that internationally common properties (e.g. fire
|
||||
rating of a wall) are all implemented exactly the same way across all
|
||||
vendors and projects. Naturally, not everything can be standardised
|
||||
internationally, so this allows you to create your own templates.
|
||||
|
||||
You may either create a property template to store properties, or a
|
||||
quantity template to store quantities. For convenience, we will always
|
||||
call them "property templates" as they are conceptually very similar.
|
||||
|
||||
This function only creates a template for the property set, not the
|
||||
properties themselves within the property set. At this level, you are
|
||||
allowed to define the name of the property set, whether it is type or
|
||||
occurrence based, and which entities it applies to.
|
||||
|
||||
See the documentation for IfcPropertySetTemplate for instructions on
|
||||
the types of template type and list of applicable entities.
|
||||
|
||||
The types of property set templates are:
|
||||
|
||||
* PSET_TYPEDRIVENONLY - assigned only to types
|
||||
* PSET_TYPEDRIVENOVERRIDE - assigned to types or occurrences. If both,
|
||||
the occurrence overrides the type.
|
||||
* PSET_OCCURRENCEDRIVEN - assigned to occurrences only.
|
||||
* PSET_PERFORMANCEDRIVEN - assigned as a timeseries data range. This is
|
||||
only recommended for advanced users.
|
||||
* QTO_TYPEDRIVENONLY - assigned only to types, but for quantities.
|
||||
* QTO_TYPEDRIVENOVERRIDE - assigned to types or occurrences, but for
|
||||
quantities. If both, the occurrence overrides the type.
|
||||
* QTO_OCCURRENCEDRIVEN - assigned to occurrences only, but for
|
||||
quantities.
|
||||
|
||||
By default, this creates a template that can be applied to types, but
|
||||
overridden by occurrences, and is applicable to everything.
|
||||
|
||||
:param name: The name of the property set
|
||||
:type name: str,optional
|
||||
:param template_type: Choose from one of PSET_TYPEDRIVENONLY,
|
||||
PSET_TYPEDRIVENOVERRIDE, PSET_OCCURRENCEDRIVEN,
|
||||
PSET_PERFORMANCEDRIVEN, QTO_TYPEDRIVENONLY, QTO_TYPEDRIVENOVERRIDE,
|
||||
QTO_OCCURRENCEDRIVEN, NOTDEFINED
|
||||
:type template_type: str,optional
|
||||
:param applicable_entity: The entity that this template is allowed to be
|
||||
applied to. For example, IfcWall means that the property set may be
|
||||
assigned to walls only. IfcTypeObject, the default, means that the
|
||||
property set may be assigned to any type.
|
||||
:type applicable_entity: str,optional
|
||||
:return: The newly created IfcPropertySetTemplate
|
||||
:rtype: ifcopenshell.entity_instance.entity_instance
|
||||
|
||||
Example::
|
||||
|
||||
# Create a simple template that may be applied to all types
|
||||
ifcopenshell.api.run("pset_template.add_pset_template", model, name="ABC_RiskFactors")
|
||||
|
||||
# Note that we aren't finished yet. Our property set template
|
||||
# doesn't have any properties in it. Let's add a minimum of one
|
||||
# property.
|
||||
ifcopenshell.api.run("pset_template.add_prop_template", model, pset_template=template,
|
||||
name="HighVoltage", description="Whether there is a risk of high voltage.",
|
||||
primary_measure_type="IfcBoolean")
|
||||
"""
|
||||
self.file = file
|
||||
self.settings = {}
|
||||
for key, value in settings.items():
|
||||
self.settings[key] = value
|
||||
self.settings = {"name": name, "template_type": template_type, "applicable_entity": applicable_entity}
|
||||
|
||||
def execute(self):
|
||||
return self.file.create_entity(
|
||||
"IfcPropertySetTemplate",
|
||||
**{
|
||||
"GlobalId": ifcopenshell.guid.new(),
|
||||
"Name": "New_Pset",
|
||||
"TemplateType": "PSET_TYPEDRIVENONLY",
|
||||
"ApplicableEntity": "IfcTypeObject",
|
||||
}
|
||||
GlobalId=ifcopenshell.guid.new(),
|
||||
Name=self.settings["name"],
|
||||
TemplateType=self.settings["template_type"],
|
||||
ApplicableEntity=self.settings["applicable_entity"],
|
||||
)
|
||||
|
||||
@@ -18,11 +18,32 @@
|
||||
|
||||
|
||||
class Usecase:
|
||||
def __init__(self, file, **settings):
|
||||
def __init__(self, file, prop_template=None, attributes=None):
|
||||
"""Edits the attributes of an IfcSimplePropertyTemplate
|
||||
|
||||
For more information about the attributes and data types of an
|
||||
IfcSimplePropertyTemplate, consult the IFC documentation.
|
||||
|
||||
:param prop_template: The IfcSimplePropertyTemplate entity you want to edit
|
||||
:type prop_template: ifcopenshell.entity_instance.entity_instance
|
||||
:param attributes: a dictionary of attribute names and values.
|
||||
:type attributes: dict, optional
|
||||
:return: None
|
||||
:rtype: None
|
||||
|
||||
Example::
|
||||
|
||||
template = ifcopenshell.api.run("pset_template.add_pset_template", model, name="ABC_RiskFactors")
|
||||
|
||||
# Here's a property with just default values.
|
||||
prop = ifcopenshell.api.run("pset_template.add_prop_template", model, pset_template=template)
|
||||
|
||||
# Let's edit it to give the actual values we need.
|
||||
ifcopenshell.api.run("pset_template.edit_prop_template", model,
|
||||
prop_template=prop, attributes={"Name": "DemoA", "PrimaryMeasureType": "IfcLengthMeasure"})
|
||||
"""
|
||||
self.file = file
|
||||
self.settings = {"prop_template": None, "attributes": {}}
|
||||
for key, value in settings.items():
|
||||
self.settings[key] = value
|
||||
self.settings = {"prop_template": prop_template, "attributes": attributes or {}}
|
||||
|
||||
def execute(self):
|
||||
for name, value in self.settings["attributes"].items():
|
||||
|
||||
@@ -18,11 +18,30 @@
|
||||
|
||||
|
||||
class Usecase:
|
||||
def __init__(self, file, **settings):
|
||||
def __init__(self, file, pset_template=None, attributes=None):
|
||||
"""Edits the attributes of an IfcPropertySetTemplate
|
||||
|
||||
For more information about the attributes and data types of an
|
||||
IfcPropertySetTemplate, consult the IFC documentation.
|
||||
|
||||
:param pset_template: The IfcPropertySetTemplate entity you want to edit
|
||||
:type pset_template: ifcopenshell.entity_instance.entity_instance
|
||||
:param attributes: a dictionary of attribute names and values.
|
||||
:type attributes: dict, optional
|
||||
:return: None
|
||||
:rtype: None
|
||||
|
||||
Example::
|
||||
|
||||
# Whoops! We named it with a buildingSMART reserved "Pset_" prefix!
|
||||
template = ifcopenshell.api.run("pset_template.add_pset_template", model, name="Pset_RiskFactors")
|
||||
|
||||
# Let's fix it to prefix with our company code instead.
|
||||
ifcopenshell.api.run("pset_template.edit_pset_template", model,
|
||||
pset_template=template, attributes={"Name": "ABC_RiskFactors"})
|
||||
"""
|
||||
self.file = file
|
||||
self.settings = {"pset_template": None, "attributes": {}}
|
||||
for key, value in settings.items():
|
||||
self.settings[key] = value
|
||||
self.settings = {"pset_template": pset_template, "attributes": attributes or {}}
|
||||
|
||||
def execute(self):
|
||||
for name, value in self.settings["attributes"].items():
|
||||
|
||||
@@ -20,11 +20,31 @@ import ifcopenshell.util.element
|
||||
|
||||
|
||||
class Usecase:
|
||||
def __init__(self, file, **settings):
|
||||
def __init__(self, file, prop_template=None):
|
||||
"""Removes a property template
|
||||
|
||||
Note that a property set template should always have at least one
|
||||
property template to be valid, so take care when removing property
|
||||
templates.
|
||||
|
||||
:param prop_template: The IfcSimplePropertyTemplate to remove.
|
||||
:type prop_template: ifcopenshell.entity_instance.entity_instance
|
||||
:return: None
|
||||
:rtype: None
|
||||
|
||||
Example::
|
||||
|
||||
template = ifcopenshell.api.run("pset_template.add_pset_template", model, name="ABC_RiskFactors")
|
||||
|
||||
# Here's two propertes with just default values.
|
||||
prop1 = ifcopenshell.api.run("pset_template.add_prop_template", model, pset_template=template)
|
||||
prop2 = ifcopenshell.api.run("pset_template.add_prop_template", model, pset_template=template)
|
||||
|
||||
# Let's remove the second one.
|
||||
ifcopenshell.api.run("pset_template.remove_prop_template", model, prop_template=prop2)
|
||||
"""
|
||||
self.file = file
|
||||
self.settings = {"prop_template": None}
|
||||
for key, value in settings.items():
|
||||
self.settings[key] = value
|
||||
self.settings = {"prop_template": prop_template}
|
||||
|
||||
def execute(self):
|
||||
for inverse in self.file.get_inverse(self.settings["prop_template"]):
|
||||
|
||||
@@ -20,9 +20,27 @@ import ifcopenshell.util.element
|
||||
|
||||
|
||||
class Usecase:
|
||||
def __init__(self, file, **settings):
|
||||
def __init__(self, file, pset_template=None):
|
||||
"""Removes a property set template
|
||||
|
||||
All property templates within the property set template are also removed
|
||||
along with it.
|
||||
|
||||
:param pset_template: The IfcPropertySetTemplate to remove.
|
||||
:type pset_template: ifcopenshell.entity_instance.entity_instance
|
||||
:return: None
|
||||
:rtype: None
|
||||
|
||||
Example::
|
||||
|
||||
# Create a template.
|
||||
template = ifcopenshell.api.run("pset_template.add_pset_template", model, name="ABC_RiskFactors")
|
||||
|
||||
# Let's remove the template.
|
||||
ifcopenshell.api.run("pset_template.remove_pset_template", model, pset_template=template)
|
||||
"""
|
||||
self.file = file
|
||||
self.settings = {"pset_template": None}
|
||||
self.settings = {"pset_template": pset_template}
|
||||
for key, value in settings.items():
|
||||
self.settings[key] = value
|
||||
|
||||
|
||||
Reference in New Issue
Block a user