Object water area output (Water Overlay) - Revision history

Maxim@tygron.com at 13:52, 28 November 2025

2025-11-28T13:52:39Z

← Older revision		Revision as of 13:52, 28 November 2025
Line 13:		Line 13:
	* The array contains first the [[Water level area (Water Overlay)]] IDs, secondly the area in m2 of the connecting element and thirdly the elevation of the connecting element.		* The array contains first the [[Water level area (Water Overlay)]] IDs, secondly the area in m2 of the connecting element and thirdly the elevation of the connecting element.
	* 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 breach an ~~addional~~ ID is added: [id1, id2, id3, area1, area2, area3, elevation1, elevation2, elevation3].		* For sewer overflows and breach 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]]

Maxim@tygron.com at 13:52, 28 November 2025

2025-11-28T13:52:08Z

← Older revision		Revision as of 13:52, 28 November 2025
Line 2:		Line 2:
	{{overlay keys\|type=row\|group=Water Overlay		{{overlay keys\|type=row\|group=Water Overlay
	\|key=OBJECT_WATER_AREA_OUTPUT		\|key=OBJECT_WATER_AREA_OUTPUT
	\|unit=[[item]] ID, ~~number~~		\|unit=[[item]] ID, m2, m
	\|description=An [[Attribute array\|array]] of [[Water level area (Water Overlay)]] IDs, connected to a specific [[Hydraulic structures (Water Overlay)\|hydraulic structure]] or [[Hydrologic features (Water Overlay)\|hydrologic feature]].		\|description=An [[Attribute array\|array]] of [[Water level area (Water Overlay)]] IDs, connected to a specific [[Hydraulic structures (Water Overlay)\|hydraulic structure]] or [[Hydrologic features (Water Overlay)\|hydrologic feature]].
	\|defaultvalue=None		\|defaultvalue=None

Maxim@tygron.com at 13:51, 28 November 2025

2025-11-28T13:51:46Z

← Older revision		Revision as of 13:51, 28 November 2025
Line 2:		Line 2:
	{{overlay keys\|type=row\|group=Water Overlay		{{overlay keys\|type=row\|group=Water Overlay
	\|key=OBJECT_WATER_AREA_OUTPUT		\|key=OBJECT_WATER_AREA_OUTPUT
	\|unit=[[item]] ID		\|unit=[[item]] ID, number
	\|description=An [[Attribute array\|array]] of [[Water level area (Water Overlay)]] IDs, connected to a specific [[Hydraulic structures (Water Overlay)\|hydraulic structure]] or [[Hydrologic features (Water Overlay)\|hydrologic feature]].		\|description=An [[Attribute array\|array]] of [[Water level area (Water Overlay)]] IDs, connected to a specific [[Hydraulic structures (Water Overlay)\|hydraulic structure]] or [[Hydrologic features (Water Overlay)\|hydrologic feature]].
	\|defaultvalue=None		\|defaultvalue=None
Line 11:		Line 11:
	{{article end		{{article end
	\|notes=		\|notes=
			* The array contains first the [[Water level area (Water Overlay)]] IDs, secondly the area in m2 of the connecting element and thirdly the elevation of the connecting element.
			* The array is defined as: [id1, id2, area1, area2, elevation1, elevation2].
			* For sewer overflows and breach an addional 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]]

Frank@tygron.nl at 15:25, 14 November 2025

2025-11-14T15:25:47Z

← Older revision		Revision as of 15:25, 14 November 2025
Line 8:		Line 8:
	\|range=0 to {{integermaxvalue}}		\|range=0 to {{integermaxvalue}}
	}}</onlyinclude>}}		}}</onlyinclude>}}

	~~All [[Hydraulic_structures_(Water_Overlay)\|hydraulic structures]] have an OBJECT_DATUM_OUTPUT_A attribute.~~
	[[File:Weir_schematic.PNG\|200px\|thumb\|left\|A weir showing the datum heights at that timeframe, obtained from the values of the OBJECT_DATUM_OUTPUT_A and OBJECT_DATUM_OUTPUT_B [[Overlay key\|key]] stored in that weir.]]

	{{article end		{{article end
	\|notes=		\|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. When the calculation is complete, the attribute is updated automatically.
	* 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.
	* This attribute is also visible when zoomed in on a [[Hydraulic_structures_(Water_Overlay)\|hydraulic structure]]. The [[Water_level_(Water_Overlay)\|water level]]s on either side of the structure can be seen at each timeframe when a [[Water Overlay]] is selected.
	\|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]]
	* [[How to export an Object output attribute as measurement]]		* [[How to export an Object output attribute as measurement]]
	\|seealso=		\|seealso=
	* [[~~Hydraulic_structures_~~(~~Water_Overlay~~)\|Hydraulic structures]]		* [[Hydraulic structures (Water Overlay)\|Hydraulic structures]]
			* [[Hydrologic features (Water Overlay)\|Hydrologic features]]
	* [[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]]

Frank@tygron.nl at 15:24, 14 November 2025

2025-11-14T15:24:34Z

← Older revision		Revision as of 15:24, 14 November 2025
Line 3:		Line 3:
	\|key=OBJECT_WATER_AREA_OUTPUT		\|key=OBJECT_WATER_AREA_OUTPUT
	\|unit=[[item]] ID		\|unit=[[item]] ID
	\|description=An [[Attribute array\|array]] of ~~[[item]] IDs, one per~~ [[Water level area (Water Overlay)]], ~~related~~ to a specific [[Hydraulic structures (Water Overlay)\|hydraulic structure]] or [[Hydrologic features (Water Overlay)\|hydrologic feature]].		\|description=An [[Attribute array\|array]] of [[Water level area (Water Overlay)]] IDs, connected to a specific [[Hydraulic structures (Water Overlay)\|hydraulic structure]] or [[Hydrologic features (Water Overlay)\|hydrologic feature]].
	\|defaultvalue=None		\|defaultvalue=None
	\|icon=		\|icon=
	\|range=~~-{{max surface}}~~ to {{~~max surface~~}}		\|range=0 to {{integermaxvalue}}
	}}</onlyinclude>}}		}}</onlyinclude>}}

Frank@tygron.nl at 15:23, 14 November 2025

2025-11-14T15:23:19Z

← Older revision		Revision as of 15:23, 14 November 2025
Line 3:		Line 3:
	\|key=OBJECT_WATER_AREA_OUTPUT		\|key=OBJECT_WATER_AREA_OUTPUT
	\|unit=[[item]] ID		\|unit=[[item]] ID
	\|description=An [[Attribute array\|array]] of [[item]] IDs, one per [[Water level area (Water Overlay)]], related to a specific [[Hydraulic ~~structure~~ (Water Overlay)\|hydraulic structure]] or [[Hydrologic ~~feature~~ (Water Overlay)\|hydrologic feature]].		\|description=An [[Attribute array\|array]] of [[item]] IDs, one per [[Water level area (Water Overlay)]], related to a specific [[Hydraulic structures (Water Overlay)\|hydraulic structure]] or [[Hydrologic features (Water Overlay)\|hydrologic feature]].
	\|defaultvalue=None		\|defaultvalue=None
	\|icon=		\|icon=

Frank@tygron.nl: Created page with "{{overlay keys| {{overlay keys|type=row|group=Water Overlay |key=OBJECT_WATER_AREA_OUTPUT |unit=item ID |description=An array of item IDs, one per Water level area (Water Overlay), related to a specific hydraulic structure or hydrologic feature. |defaultvalue=None |icon= |range=-{{max surface}} to {{max surface}} }}}} All Hydraulic_..."

2025-11-14T15:23:03Z

Created page with "{{overlay keys|<onlyinclude> {{overlay keys|type=row|group=Water Overlay |key=OBJECT_WATER_AREA_OUTPUT |unit=item ID |description=An array of item IDs, one per Water level area (Water Overlay), related to a specific hydraulic structure or hydrologic feature. |defaultvalue=None |icon= |range=-{{max surface}} to {{max surface}} }}</onlyinclude>}} All Hydraulic_..."

New page

{{overlay keys|<onlyinclude>
{{overlay keys|type=row|group=Water Overlay
|key=OBJECT_WATER_AREA_OUTPUT
|unit=[[item]] ID
|description=An [[Attribute array|array]] of [[item]] IDs, one per [[Water level area (Water Overlay)]], related to a specific [[Hydraulic structure (Water Overlay)|hydraulic structure]] or [[Hydrologic feature (Water Overlay)|hydrologic feature]].
|defaultvalue=None
|icon=
|range=-{{max surface}} to {{max surface}}
}}</onlyinclude>}}

All [[Hydraulic_structures_(Water_Overlay)|hydraulic structures]] have an OBJECT_DATUM_OUTPUT_A attribute.
[[File:Weir_schematic.PNG|200px|thumb|left|A weir showing the datum heights at that timeframe, obtained from the values of the OBJECT_DATUM_OUTPUT_A and OBJECT_DATUM_OUTPUT_B [[Overlay key|key]] stored in that weir.]]

{{article end
|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. When the calculation is complete, the attribute is updated automatically.
* 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.
* This attribute is also visible when zoomed in on a [[Hydraulic_structures_(Water_Overlay)|hydraulic structure]]. The [[Water_level_(Water_Overlay)|water level]]s on either side of the structure can be seen at each timeframe when a [[Water Overlay]] is selected.
|howtos=
* [[How to inspect object output attributes of an overlay using the measurement tool]]
* [[How to export an Object output attribute as measurement]]
|seealso=
* [[Hydraulic_structures_(Water_Overlay)|Hydraulic structures]]
* [[Water_level_(Water_Overlay)|Water level]]
* [[Weir height test case (Water Module)|Weir flow test case]]
}}

{{WaterOverlay hydraulic structure nav}}
{{WaterOverlay output nav}}