Enum - GaugeOutputMode

Key: enum.gaugeOutputMode

Defines how a gauge of kind standard or subGauge contributes to the building total consumption formula. Virtual gauges have no outputMode (the field is null and hidden in the UI). The system derives the arithmetic sign in the building total formula by combining outputMode with the gauge's direction: include + import = added, include + export = subtracted, subtract + import = subtracted, subtract + export = added, exclude / reportOnly = ignored. Changes to outputMode trigger a building total formula review.

Values

Value	Description
include	The gauge's consumption is included in the building total formula. The arithmetic sign is derived from direction: import is added, export is subtracted. Used for the primary consumption meters of a building.
subtract	The gauge's consumption is subtracted from the building total (when direction = import) or added back (when direction = export). Used for energy consumed by a third-party tenant or sub-entity whose consumption should be removed from the building's own total.
exclude	The gauge is not part of any building total formula and is not visible in reports by default. Used for gauges that are tracked but have no relevance to the building's energy accounting.
reportOnly	Not included in the building total formula, but visible in reports and available for use in Virtual Gauge formulas. Used when automatic inclusion would risk double-counting — e.g. an FVE production meter whose output is partly self-consumed and partly exported to the grid.

References

• gauge.outputMode
• Gauge Management (feature)