remove_objects
Delete all objects of a specified type in an EnergyPlus model, with optional forced removal even if referenced. Use for replace-all semantics on collections without individual identities.
Instructions
Delete every object of the given type. No-op when none exist.
Intended for types where individual entries have no canonical addressable
identity (Output:Variable, Output:Meter, …): those parse with
_name="" to support duplicates, so remove_object cannot reach them
individually. Use this when the calling tool owns the entire collection
and wants replace-all semantics (e.g. an output-picker UI).
Blocked when any entry is referenced by other objects unless force=True.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| force | No | Remove even if some entries are referenced by other objects. | |
| object_type | Yes | EnergyPlus object type. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | ||
| removed | Yes | ||
| object_type | Yes |