Click or drag to resize

IBridgeStructure Properties

The IBridgeStructure type exposes the following members.

Properties
  NameDescription
Public propertyAlpha
Alpha tables
Public propertyBackRat
Back water ratio table
Public propertyBaseCoef
BaseCoefficient tables
Public propertyBeta
Beta tables
Public propertyBottomlevel
Bottom level
Public propertyBridgeGeometry
BridgeGeometry
Public propertyBridgeOverflow
Overflow
Public propertyBridgeSubmergence
Submergence
Public propertyBridgeTableFilePath
Holds the smoothed table Type : Water level or discharge depending on the chosen calculation mode Unit: [m3/s] or [meter] Default: 0.0
Public propertyColumnHeader
Holds the header for the columns Type : Water level Unit: [meter] Default: 0.0
Public propertyConvTubeNumber
Number of tubes for conveyance tube analyses.
Public propertyCulvertID
The culvert used otherwise null
Public propertydDischargedDownStreamWaterLevel
Calculated Discharge derivative with UpStreamWaterLevel. Upstream is relative to the direction of chainage. Unit: [m^2/s]
(Inherited from IStructure.)
Public propertydDischargedUpStreamWaterLevel
Calculated Discharge derivative with DownStreamWaterLevel. Downstream is relative to the direction of chainage. Unit: [m^2/s]
(Inherited from IStructure.)
Public propertyDelhs
Level from where the variation is forced to be linear.
(Inherited from ILinearZeroVariation.)
Public propertyDischarge
Calculated Discharge Unit: [m^3/s]
(Inherited from IStructure.)
Public propertyDisCoefType
Loss factor Ratio Dis Coef Type, 0 - Contraction m = (1-M), 1 - Opening m = M
Public propertyDownstreamWaterLevel
Downstream water level.Downstream refers to the direction of chainge. The water level is set by use of SetWaterLevels Unit: [m]
(Inherited from IStructure.)
Public propertyDykes1
Dykes1 tables
Public propertyDykes2
Dykes2 tables
Public propertyEccentricity
Eccentricity tables
Public propertyEnchroachmentRegenerate
Boolean telling if Enchroachment regenerate
Public propertyEntrance
Entrance tables
Public propertyFlowFactor
The discharge (and discharge derivatives) are scaled by the flow factor.
(Inherited from IStructure.)
Public propertyFroude
Froude tables
Public propertyGridSizeDownStream
Slotsize of table downstream
Public propertyGridSizeUpStream
Slotsize of table upstream
Public propertyID
Name of the structure.
(Inherited from IStructure.)
Public propertyIDInUserUnit Obsolete.
Used to get a consistent description of the structure. The ID comes in user units. Used e.g. when reporting errors, warnings and hints.
(Inherited from IStructure.)
Public propertyImplicit
Flag to control if the structure is implicit or explicit. If the structure is explicit (Implicit == false) then the derivatives of the discharge are always zero. Default value: true
(Inherited from IStructure.)
Public propertyInvertLevelDownstream
Invert level down stream The invert level is the level where water starts flowing in to the structure from the downstream side. It does not necessarily flow through the structure.
(Inherited from IStructure.)
Public propertyInvertLevelUpstream
Invert level up stream. The invert level is the level where water starts flowing in to the structure from the upstream side. It does not necessarily flow through the structure.
(Inherited from IStructure.)
Public propertyIsAsymmetric
Boolean telling whether to use IsAsymmetric
Public propertyIsMultiWayOpen
Boolean telling whether to use IsMultiWayOpen
Public propertyLength Obsolete.
Length of the structure. Unit: [m]
(Inherited from IStructure.)
Public propertyLocation
Location of structure.
(Inherited from IStructure.)
Public propertyMaximumWaterDepthAboveXSFactor
Public propertyMethod
Bridge Method - FHWA, USBPR, Energy, HR, Nagler, Yarnell
Public propertyPiers
Piers tables
Public propertyRoad1
Road1 tables
Public propertyRoad2
Road2 tables
Public propertyRowHeader
Holds the header for the rows Type : Water level Unit: [meter] Default: 0.0
Public propertyRunTimeDiagnostics
The getter is used to get a list of errors. OBSOLETE
(Inherited from IStructure.)
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).

(Inherited from IStructure.)
Public propertySideStructureReservoir
Reservoir at end of side structure. Null if not side structure, or no reservoir is defined
(Inherited from IStructure.)
Public propertySkew
Skew tables
Public propertySmoothBridgeSurface
Enum describing Bridge Table smoothing filer, 0 - no filter, 1-3 different filters, -1 - Max filter
Public propertySmoothBridgeSurfaceIterations
Number of iterations the smoothing filter is applied
Public propertyStructureType
Type of structure
(Inherited from IStructure.)
Public propertySubFac
SubFac tables
Public propertySubmerged
Submerged tables
Public propertyTable
Holds the table Type : Discharge Unit: [m3/s] Default: 0.0
Public propertyTableIteration
Variable defining maximum number of iterations for precalculating tables.
Public propertyTablesGenerated
Boolean telling if the tables are generated
Public propertyTableSmooth
Holds the smoothed table Type : Water level or discharge depending on the chosen calculation mode Unit: [m3/s] or [meter] Default: 0.0
Public propertyTableType
Table input filetype 0 - DFS2 1 - ASCII Default: 0
Public propertyTheta
Theta tables
Public propertyToplevel
Top level
Public propertyTopoID
TopoID used when structure is searching for neighboring cross sections in the reach.
(Inherited from IStructure.)
Public propertyType
Structure type, unique for each type of structure.
(Inherited from IStructure.)
Public propertyUpstreamWaterLevel
Upstream water level. Upstream refers to the direction of chainage. The water level is set by use of SetWaterLevels Unit: [m]
(Inherited from IStructure.)
Public propertyUseAlpha
The velocity distribution coefficient for bridge calculations is set to unity per default. The coefficient may be calculated based on conveyance distribution. Default value: false
Public propertyUseEccentricity
Boolean telling whether to use Eccentricity
Public propertyUseFHWAReachLength
The reach length for the FHWA method is determined based on an equal conveyance tube analysis. If the reach length should only be based on the physical distance from the adjacent cross section to the bridge the variable 'USE_FHWA_REACH_LENGTH' may be used.
Public propertyUseOverflow
Boolean telling whether to use overflow
Public propertyUsePiers
Boolean telling whether to use Piers
Public propertyUsePiersPiles
Boolean telling wheter to use Piers Piles
Public propertyUsePreProcessedBridgeTable
Use preprocessed bridge tables
Public propertyUseSkewness
Boolean telling whether to use Skewness
Public propertyUseSpurDykes
Boolean telling whether to use SpurDykes
Public propertyUseSubmergence
Boolean telling whether to use submergence
Public propertyWaterLevelDatum
Datum to be applied to all water levels specified in the table. Type: water level Unit: [meter] Default: 0.0
Public propertyWeirID
The weir used otherwise null
Top
See Also