Object datum output a (Water Overlay): Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
(12 intermediate revisions by 2 users not shown)
Line 3: Line 3:
|key=OBJECT_DATUM_OUTPUT
|key=OBJECT_DATUM_OUTPUT
|unit={{mdatum}}
|unit={{mdatum}}
|description=An [[Attribute array|array]] of values, each value indicating the [[Water_level_(Water_Overlay)|water level]] at both sides of the [[Hydraulic_structures_(Water_Overlay)|hydraulic structures]] at each [[Timeframes (Water Overlay)|timeframe]].
|description=An [[Attribute array|array]] of values, two per [[Timeframes (Water Overlay)|timeframe]]. Each value indicates the [[Water_level_(Water_Overlay)|water level]] at one sides of the [[Hydraulic_structures_(Water_Overlay)|hydraulic structures]], entry or exit.
|defaultvalue=None
|defaultvalue=None
|icon=
|icon=
Line 9: Line 9:


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


{{article end
{{article end
Line 14: Line 15:
* 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.
* 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.
* 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.
* 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=
|seealso=
|seealso=
* [[Hydraulic_structures_(Water_Overlay)|Hydraulic structures]]
* [[Water_level_(Water_Overlay)|Water level]]
* [[Object_flow_output_(Water Overlay)|Object flow output]]
}}
}}


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

Revision as of 13:05, 17 May 2021

All hydraulic structures have an OBJECT_DATUM_OUTPUT attribute.

A weir showing the datum heights at that timeframe, obtained from the values of the OBJECT_DATUM_OUTPUT key stored in that weir.

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 structure. The water levels on either side of the structure can be seen at each timeframe when a Water Overlay is selected.

See also