Weir dam output (Water Overlay): Difference between revisions
Jump to navigation
Jump to search
Created page with "{{overlay keys|<onlyinclude> {{overlay keys|type=row|group=Water Overlay |key=OBJECT_WEIR_DAM_OUTPUT |unit=m |description=An array of values, each value indicating the width that the object had at the time of the timeframe recording. |defaultvalue=None |icon= |range=-{{max surface}} to {{max surface}} }}</onlyinclude>}} This attribute is automatically created for all breaches in a project when a Water Overlay|water calcul..." |
No edit summary |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{overlay keys|<onlyinclude> | {{overlay keys|<onlyinclude> | ||
{{overlay keys|type=row|group=Water Overlay | {{overlay keys|type=row|group=Water Overlay | ||
|key= | |key=WEIR_DAM_OUTPUT | ||
|unit=m | |unit=m , m + {{datum}} | ||
|description=An [[Attribute array|array]] of values | |description=An [[Attribute array|array]] of two values; the applied weir dam width and weir height | ||
|defaultvalue=None | |defaultvalue=None | ||
|icon= | |icon= | ||
|range=-{{max surface}} to {{max surface}} | |range=(0, -{{max surface}}) to {{max surface}} | ||
}}</onlyinclude>}} | }}</onlyinclude>}} | ||
{{article end | {{article end | ||
|notes= | |notes= | ||
* The Weir dam width and height are determined during rasterization phase. | |||
* 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. | * 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. | ||
* | * To avoid conflicts, each [[Water Overlay]] appends its [[ID]] to the attribute name by default. | ||
|howtos= | |howtos= | ||
* [[How to find the Object flow output attribute related to a specific Overlay]] | * [[How to find the Object flow output attribute related to a specific Overlay]] | ||
* [[How to inspect breach output attributes of an overlay using the measurement tool]] | * [[How to inspect breach output attributes of an overlay using the measurement tool]] | ||
* [[How to export an Object output attribute as measurement]] | * [[How to export an Object output attribute as measurement]] | ||
|api=*[[Api session event editor overlay set key value]] | |||
}} | }} | ||
{{WaterOverlay hydraulic structure nav}} | {{WaterOverlay hydraulic structure nav}} | ||
{{WaterOverlay output nav}} | {{WaterOverlay output nav}} | ||
Latest revision as of 12:26, 13 July 2026
| Icon | Key | Unit | Range | Description | Default value |
|---|---|---|---|---|---|
| WEIR_DAM_OUTPUT | m , m + datum | (0, -10000) to 10000 | An array of two values; the applied weir dam width and weir height | None |
Notes
- The Weir dam width and height are determined during rasterization phase.
- 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.
- To avoid conflicts, each Water Overlay appends its ID to the attribute name by default.
How-to's
- How to find the Object flow output attribute related to a specific Overlay
- How to inspect breach output attributes of an overlay using the measurement tool
- How to export an Object output attribute as measurement
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