The following project variables relate to the Lakes variable category. They refer to the attributes of the project lakes. These project variables must all be prefixed with %Lakes. eg., %Lakes.LakeID.
LakesExist |
Returns True if lakes exists, otherwise False |
True / False |
|
NumberOfLakes |
The number of lakes |
|
|
LakeID |
The integer value of the lake |
Integer |
|
LakePolygon[i].SubCatchmentID |
The Subcatchment ID that the lakes falls mostly within (if none,-1 will be returned). |
Integer |
|
LakePolygon[i].SubCatchmentName |
The Subcatchment label that the lakes falls mostly within (if none,’none’ will be returned). |
Text |
|
LakePolygon[i].Area |
The lake ‘i’ area. |
Decimal |
m2 |
LakePolygon[i].Perimeter |
The lake ‘i’ perimeter length. |
Decimal |
m |
LakePolygon[i].Shape |
The lake ‘i’ shape coefficient (Area / (Perimeter Length) 2 ). |
Decimal |
m2/ m2 |
LakePolygon[i].Depth |
The depth of the lake ‘i’*. |
Decimal |
m |
LakePolygon[i].Volume |
The volume of the lake ‘i’*. |
Decimal |
m3 |
LakePolygon[i].MaxSurfaceElevation |
The overflow elevation of the lake ‘i’ (lowest elevation of perimeter pixels). |
Decimal |
map units |
LakePolygon[i].MinPerimElevPixRow |
The overflow pixel row of the lake ‘i’ perimeter. |
Integer |
|
LakePolygon[i].MinPerimElevPixCol |
The overflow pixel column of the lake ‘i’ perimeter. |
Integer |
|
LakePolygon[i].NumberOfRegions |
The number of regions in the lake ‘i’ polygon. |
Integer |
|
LakePolygon[i].Region[j].NoOfVertex |
The number of vertices in the ‘j’ region of the lake ‘i’. |
Integer |
|
LakePolygon[i].Region[j].Vertex[k].Easting |
The easting of the ‘k’ vertex in the ‘j’ region of the ‘i’ lake. |
Decimal |
user coordinate |
LakePolygon[i].Region[j].Vertex[k].Northing |
The northing of the ‘k’ vertex in the ‘j’ region of the ‘i’ lake. |
Decimal |
user coordinate |
LakePolygon[i].Region[j].Vertex[k].Elevation |
The elevation of the ‘k’ vertex in the ‘j’ region of the ‘i’ lake. |
Decimal |
m |
LakePolygon[i].NumberOfStageAreaVolumeSteps |
The number of steps in the calculated Stage-Area-Volume (SAV) relationship for lake ‘i’ |
Integer |
|
LakePolygon[i].SAV[j].Elevation |
The elevation of the SAV step ‘j’ for lake ‘i’ |
Decimal |
m |
LakePolygon[i].SAV[j].Stage |
The stage of the SAV step ‘j’ for lake ‘i’ |
Decimal |
m |
LakePolygon[i].SAV[j].Area |
The area of the SAV step ‘j’ for lake ‘i’ |
Decimal |
m2 |
LakePolygon[i].SAV[j].Volume |
The volume of the SAV step ‘j’ for lake ‘i’ |
Decimal |
m3 |
* These functions require a realistic lake bottom profile in the DEM and for the lake not to have been breached by the breaching algorithm.
