ifcopenshell.api.constraint.remove_metric

Module Contents

class ifcopenshell.api.constraint.remove_metric.Usecase
delete_reference(reference)
execute()
ifcopenshell.api.constraint.remove_metric.remove_metric(file: ifcopenshell.file, metric: ifcopenshell.entity_instance) 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.constraint.add_objective(model)
metric = ifcopenshell.api.constraint.add_metric(model,
    objective=objective)
ifcopenshell.api.constraint.remove_metric(model,
    metric=metric)