Object water area output (Water Overlay): Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 13: | Line 13: | ||
* The array contains [[Water level area (Water Overlay)]] IDs, followed by the area (m2) and elevation of the connecting elements. | * The array contains [[Water level area (Water Overlay)]] IDs, followed by the area (m2) and elevation of the connecting elements. | ||
* The array is defined as: [id1, id2, area1, area2, elevation1, elevation2]. | * The array is defined as: [id1, id2, area1, area2, elevation1, elevation2]. | ||
* For sewer overflows and | * For sewer overflows and breaches an additional ID is added: [id1, id2, id3, area1, area2, area3, elevation1, elevation2, elevation3]. | ||
|howtos= | |howtos= | ||
* [[How to inspect object output attributes of an overlay using the measurement tool]] | * [[How to inspect object output attributes of an overlay using the measurement tool]] | ||
| Line 22: | Line 22: | ||
* [[Water_level_(Water_Overlay)|Water level]] | * [[Water_level_(Water_Overlay)|Water level]] | ||
* [[Weir height test case (Water Module)|Weir flow test case]] | * [[Weir height test case (Water Module)|Weir flow test case]] | ||
|api=*[[Api session event editor overlay set key value]] | |||
*[[Api session event editor building set attribute]] | |||
}} | }} | ||
{{WaterOverlay hydraulic structure nav}} | {{WaterOverlay hydraulic structure nav}} | ||
{{WaterOverlay output nav}} | {{WaterOverlay output nav}} | ||
Latest revision as of 11:00, 15 July 2026
| Icon | Key | Unit | Range | Description | Default value |
|---|---|---|---|---|---|
| OBJECT_WATER_AREA_OUTPUT | item ID, m2, m | 0 to 2147483647 | An array of Water level area (Water Overlay) IDs, connected to a specific hydraulic structure or hydrologic feature. | None |
Notes
- The array contains Water level area (Water Overlay) IDs, followed by the area (m2) and elevation of the connecting elements.
- The array is defined as: [id1, id2, area1, area2, elevation1, elevation2].
- For sewer overflows and breaches an additional ID is added: [id1, id2, id3, area1, area2, area3, elevation1, elevation2, elevation3].
How-to's
- How to inspect object output attributes of an overlay using the measurement tool
- How to export an Object output attribute as measurement
See also
API Endpoints
- Group
- 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