Object height output (Water Overlay)

Icon	Key	Unit	Range	Description	Default value
	OBJECT_HEIGHT_OUTPUT	m + datum	-10000 to 10000	An array of values, each value indicating the height that the object had at the time of the timeframe recording.	None

This attribute is automatically created for all weirs in a project when a water calculation is performed. When the calculation is complete, the attribute is updated automatically.

Notes

• This attribute does not need to be created when configuring the project. This attribute is created automatically by the Water Overlay when a calculation is performed.
• Each Water Overlay will create this attribute with the ID of an Overlay appended to it, to prevent the results of multiple Water Overlays storing their results in the same attribute by default.

How-to's

• How to find the Object flow output attribute related to a specific Overlay
• How to inspect object output attributes of an overlay using the measurement tool
• How to export an Object output attribute as measurement

See also

• Weir height test case

API Endpoints

• Api session event editor overlay set key value

---

Water Module

Water Module

Tutorials

Overview

Theory

Benchmarks

Group

Hydraulic structures

Inlet

Inlet q • Inlet area • Inlet capacity •  Lower threshold •  Upper threshold • Inlet underground

Pump

Pump q •  Lower threshold •  Upper threshold • Pump angle • Pump capacity • Pump area

Culvert

Culvert diameter • Culvert rectangular height • Culvert threshold • Culvert n

Weir

Weir height • Weir width • Weir angle • Weir coefficient • Weir n • Weir target level

Sewer overflow

Sewer overflow • Sewer overflow speed

Drainage

Drainage q • Drainage datum • Drainage active • Drainage overflow threshold

Output

Object flow output • Object height output • Object datum output a • Object datum output b • Object water area output • Object width output • Weir dam output

Related

Building attributes • Hydrological features •  Terrain attributes • Model attributes • Results • Simulation data

---

Water Module

Water Module

Tutorials

Overview

Theory

Benchmarks

Group

Results

Output keys

Object flow output • Object height output • Object datum output a • Object datum output b • Object width output

Output other

Result type • Water balance • System visualization • Weather visualization • Debug info

Related

Building attributes • Hydraulic structures • Hydrological features •  Terrain attributes • Model attributes • Prequels • Simulation data