Click or drag to resize

Structure Properties

The Structure type exposes the following members.

Properties
  NameDescription
Public propertydDischargedDownStreamWaterLevel
Calculated Discharge derivative with DownStreamWaterLevel. Downstream is relative to the direction of chainage. The value is calculated by SetWaterLevels. Unit: [m^2/s]
Public propertydDischargedUpStreamWaterLevel
Calculated Discharge derivative with UpStreamWaterLevel. Upstream is relative to the direction of chainage. The value is calculated by SetWaterLevels. Unit: [m^2/s]
Public propertyDischarge
Calculated Discharge. The value is calculated by SetWaterLevels. Unit: [m^3/s]
Public propertyDownstreamWaterLevel
Downstream water level.Downstream refers to the direction of chainage. The water level is set by use of SetWaterLevels Unit: [m]
Public propertyExtensionData
Property used by (de)serializer, when it can not find proper target for a data field. Support of forward compatible data contracts.
Public propertyFlowArea
Flow area through structure. Used by most (but not all) structures.
Public propertyFlowFactor
The discharge (and discharge derivatives) are scaled by the flow factor.
Public propertyID
Structure ID
Public propertyIDInUserUnit
Used to get a consistent description of the structure. The ID comes in user units. Used e.g. when reporting errors, warnings and hints.
Public propertyImplicit
Flag to control if the structure is implicit or explicit. If the structure is explicit (Implicit == false) then the derivatives of the dicharge are always zero. Default value: true
Public propertyInvertLevelDownstream
Invert level down stream
Public propertyInvertLevelUpstream
Invert level up stream
Public propertyLength
Length of the structure. Unit: [m] Default value: 0m
Public propertyLocation
Location property.
Public propertyRunTimeDiagnostics
The getter is used to get a list of errors.
Public propertySideStructureBank
Bank side that side-structure is located on

If side structure contains reservoir, and has the Coordinate set, this is not used (and should be set to Undefined).

Public propertySideStructureReservoir
Reservoir at end of side structure. Null if not side structure, or no reservoir is defined
Public propertyStructureType
Type of structure
Public propertyTopoID
String used to identified cross sections
Public propertyType
Structure type, unique for each type structure.
Public propertyUpstreamWaterLevel
Upstream water level. Upstream refers to the direction of chainage. The water level is set by use of SetWaterLevels Unit: [m]
Top
See Also