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

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
46,429 edits
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:
|key=OBJECT_DATUM_OUTPUT_A
|key=OBJECT_DATUM_OUTPUT_A
|unit={{mdatum}}
|unit={{mdatum}}
|description=An [[Attribute array|array]] of values, one per [[Timeframes (Water Overlay)|timeframe]]. Each value indicates the [[Water_level_(Water_Overlay)|water level]] at one side of the [[Hydraulic_structures_(Water_Overlay)|hydraulic structures]], generally the entry.
|description=An [[Attribute array|array]] of values, one per [[Timeframes (Water Overlay)|timeframe]]. Each value indicates the [[Water_level_(Water_Overlay)|water level]] at one side of the [[Hydraulic_structures_(Water_Overlay)|hydraulic structure]], generally the entry.
|defaultvalue=None
|defaultvalue=None
|icon=
|icon=
Line 15: Line 15:
|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.
* 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.
* To avoid conflicts between multiple Water Overlays, each overlay appends its [[ID]] to this attribute name.
* 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 levels]] 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]]
Line 24: Line 24:
* [[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]]
}}
}}


{{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
OBJECT_DATUM_OUTPUT_A m + datum -10000 to 10000 An array of values, one per timeframe. Each value indicates the water level at one side of the hydraulic structure, generally the entry. None

All hydraulic structures have an OBJECT_DATUM_OUTPUT_A attribute.

A weir showing the datum heights at that timeframe, obtained from the values of the OBJECT_DATUM_OUTPUT_A and OBJECT_DATUM_OUTPUT_B 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.
  • To avoid conflicts between multiple Water Overlays, each overlay appends its ID to this attribute name.
  • 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.

How-to's

See also

API Endpoints

Water Module
Water Module
Tutorials
Overview
Theory
Benchmarks
Group
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
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
Retrieved from "https://support.tygron.com/w/index.php?title=Object_datum_output_a_(Water_Overlay)&oldid=91119"