ifcopenshell.api.constraint

Submodules

Package Contents

ifcopenshell.api.constraint.add_metric(file, objective=None) → None

Add a new metric benchmark

Qualitative constraints may have a series of quantitative benchmarks linked to it known as metrics. Metrics may be parametrically linked to computed model properties or quantities. Metrics need to be satisfied to meet the objective of the constraint.

Parameters:

objective (ifcopenshell.entity_instance) – The IfcObjective that this metric is a benchmark of.

Returns:

The newly created IfcMetric entity

Return type:

ifcopenshell.entity_instance

Example:

objective = ifcopenshell.api.run("constraint.add_objective", model)
metric = ifcopenshell.api.run("constraint.add_metric", model,
    objective=objective)
ifcopenshell.api.constraint.add_metric_reference(file, metric=None, reference_path=None) → None

Adds a chain of references to a metric. The reference path is a string of the form “attribute.attribute.attribute” Used to reference a value of an attribute of an instance through a metric objective entity.

ifcopenshell.api.constraint.add_objective(file) → None

Add a new objective constraint

Parametric constraints may be defined by the user. The constraint is defined by first creating an objective describing the purpose of the constraint and whether it is a hard or soft constraint. Later on, metrics may be added to check whether the constraint has been met by connecting it to properties and quantities. See ifcopenshell.api.constraint.add_metric for more information.

Returns:

The newly created IfcObjective entity

Return type:

ifcopenshell.entity_instance

Example:

# Create a new objective for code compliance requirements
objective = ifcopenshell.api.run("constraint.add_objective", model)
objective.ConstraintGrade = "ADVISORY"
objective.ObjectiveQualifier = "CODECOMPLIANCE"
# Note: the objective right now is purely qualitative and for
# information purposes. You may wish to add quantiative metrics.
ifcopenshell.api.constraint.assign_constraint(file: ifcopenshell.file, products: list[ifcopenshell.entity_instance], constraint: ifcopenshell.entity_instance) → ifcopenshell.entity_instance | None

Assigns a constraint to a list of products

This assigns a relationship between a product and a constraint, so that when a product’s properties and quantities do not match the requirements of the constraint’s metrics, results can be flagged.

It is assumed (but not explicit in the IFC documentation) that constraints are inherited from the type. This way, it is not necessary to create lots of constraint assignments.

Parameters:
Returns:

The new or updated IfcRelAssociatesConstraint relationship or None if products was an empty list.

Return type:

ifcopenshell.entity_instance

ifcopenshell.api.constraint.edit_metric(file, metric=None, attributes=None) → None

Edit the attributes of a metric

For more information about the attributes and data types of an IfcMetric, consult the IFC documentation.

Parameters:

  • metric (ifcopenshell.entity_instance) – The IfcMetric you want to edit.

  • attributes (dict, optional) – a dictionary of attribute names and values.

Returns:

None

Return type:

None

Example:

objective = ifcopenshell.api.run("constraint.add_objective", model)
metric = ifcopenshell.api.run("constraint.add_metric", model,
    objective=objective)
ifcopenshell.api.run("constraint.edit_metric", model,
    metric=metric, attributes={"ConstraintGrade": "HARD"})
ifcopenshell.api.constraint.edit_objective(file, objective=None, attributes=None) → None

Edit the attributes of a objective

For more information about the attributes and data types of an IfcObjective, consult the IFC documentation.

Parameters:

  • objective (ifcopenshell.entity_instance) – The IfcObjective you want to edit.

  • attributes (dict, optional) – a dictionary of attribute names and values.

Returns:

None

Return type:

None

Example:

objective = ifcopenshell.api.run("constraint.add_objective", model)
ifcopenshell.api.run("constraint.edit_objective", model,
    objective=objective, attributes={"ConstraintGrade": "HARD"})
ifcopenshell.api.constraint.remove_constraint(file, constraint=None) → None

Remove a constraint (typically an objective)

Removes a constraint definition and all of its associations to any products. Typically this would be an IfcObjective, although technically you can associate IfcMetrics ith products too, though the meaning may be unclear.

Parameters:

constraint (ifcopenshell.entity_instance) – The IfcObjective you want to remove.

Returns:

None

Return type:

None

Example:

objective = ifcopenshell.api.run("constraint.add_objective", model)
ifcopenshell.api.run("constraint.remove_constraint", model,
    constraint=objective)
ifcopenshell.api.constraint.remove_metric(file, metric=None) → None

Remove a metric benchmark

Removes a metric benchmark and all of its associations to any products and objectives.

Parameters:

metric (ifcopenshell.entity_instance) – The IfcMetric you want to remove.

Returns:

None

Return type:

None

Example:

objective = ifcopenshell.api.run("constraint.add_objective", model)
metric = ifcopenshell.api.run("constraint.add_metric", model,
    objective=objective)
ifcopenshell.api.run("constraint.remove_metric", model,
    metric=metric)
ifcopenshell.api.constraint.unassign_constraint(file: ifcopenshell.file, products: list[ifcopenshell.entity_instance], constraint: ifcopenshell.entity_instance) → None

Unassigns a constraint from a list of products

The constraint will not be deleted and is available to be assigned to other products.

Parameters:
Returns:

None

Return type:

None