HRBridge Methods

Methods

Accepts List of data types that is accepted, i.e., that you can get a ValueSetter for.
(Inherited from Structure)
AddToOffers Add additional offers to structure
(Inherited from Structure)
AllocateTable Allocate table of certain sizes
(Inherited from BridgeBase)
ApplyFlowFactor Applies flow factor to discharge and it's derivatives
(Inherited from Structure)
CheckBridgeCombinations Check bridge combinations
(Inherited from BridgeBase)
ControlSetFlowFactor Set flow factor to specified value
(Inherited from Structure)
Description Return a string that describes this structure. Includes structure type and ID
(Inherited from Structure)
DetermineBridgeFlow Determines the bridge flow for given upstream and downstream water level indices col and row.
(Inherited from BridgeBase)
DetermineCriticalPartOfCompositeFlow Determines part of composite flow for structure, which was marked as having critical flow with initial estimate of part of composite flow.
(Inherited from AbstractHeadLossStructure)
Dispose Frees the licenses held.
(Inherited from Structure)
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Evaluate(StructureParametersFromHD) Sets up- and down-stream water level and discharge and calculates the headloss and its derivatives.
(Inherited from AbstractHeadLossStructure)
Evaluate(Double, Double, Double) Sets up- and down-stream water level and discharge and calculates the headloss and its derivatives.
(Inherited from BridgeTabulated)
ExplicitStructureSupport DEBUG: This method is called from Validate() if _implitcit == false to check if the structure supports being Explicit. Once all structures support explicit operation this method can be deleted.
(Inherited from Structure)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GenerateBridgeTable Generates 2D table representing discharge dependence on upstream/downstream water levels.
(Inherited from BridgeBase)
GetActionInfos List of control action infos
(Inherited from Structure)
GetControlAction Get control action for the specified id. It always returns one of the ActionControl delegates. It will return null if controlActionId is not valid.

Base implementation for IControllable


(Inherited from Structure)
GetCurrentValue Get the current value of the control for the specified id.

Base implementation for IControllable


(Inherited from Structure)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetPartOfCompositeFlowEstimateFactor Provides an estimate factor for part of composite flow. Presently it is upstream structure cross-section to upstream cross-section flow area ratio.
(Inherited from BridgeTabulated)
GetTypeGets the Type of the current instance.
(Inherited from Object)
Initialize(IDiagnostics) Set up structure and set runtime diagnostics object
(Inherited from Structure)
Initialize(ICrossSection, ICrossSection, Boolean, IDiagnostics) Set up structure and set runtime diagnostics object
(Inherited from BridgeBase)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Offers A list of quantities available from this structure
(Inherited from Structure)
OnDeserializedMethod When deserialized, the BridgeBase class needs to be re-established as it was before serialization.
(Inherited from BridgeBase)
Prepare(HDParameterData, IDiagnostics) Set up structure and set runtime diagnostics object
(Inherited from BridgeBase)
Prepare(DateTime, HDParameterData, IDiagnostics) Set up structure and set runtime diagnostics object
(Inherited from Structure)
ReadBridgeTable Read bridge table from file
(Inherited from BridgeTabulated)
ReadBridgeTableASCII Read bridge table from file
(Inherited from BridgeTabulated)
ReadBridgeTableDFS2 Read bridge table from file
(Inherited from BridgeTabulated)
ResetControlledState Reset internal state (if any) used by controlling class. Called after a controlling class has performed a control sequence, and simulation is restarted.

Base implementation for IControllable


(Inherited from Structure)
SetControlStrategyId Set control strategy ID manually.

Base implementation for IControllable


(Inherited from Structure)
SetInputWaterLevels Set the _upstreamWaterLevel, _downstreamWaterLevel and _flowDir
(Inherited from Structure)
SetInvertLevel Set up invert level
(Inherited from BridgeBase)
Setup(IStructureCollection, IDiagnostics) Set structure collection information to structure
(Inherited from BridgeBase)
Setup(IStructureCollection, CrossSectionData, IDiagnostics) Set structure collection information to structure including cross sections.
(Inherited from BridgeBase)
SetWaterLevels(StructureParametersFromHD) Sets up- and down-stream water level and forces the calculation of the discharge and its derivatives.
(Inherited from AbstractHeadLossStructure)
SetWaterLevels(Double, Double) Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.

Override in extending classes to do something useful.


(Inherited from AbstractHeadLossStructure)
SetWaterLevels(Double, Double, Double, Double) Sets up- and down-stream water level and forces the calculation of the discharge and its derivatives.
(Inherited from AbstractHeadLossStructure)
SetZeroFlow Sets the conditions for zero flow
(Inherited from AbstractHeadLossStructure)
ToStringReturns a string that represents the current object.
(Inherited from Object)
UpdatedWaterLevels After a time step (or iteration) has finished, update the discharge to the actual value, based on the final water levels and the discharge derivatives.
(Inherited from Structure)
Validate Validation of data for a BridgeBase structure.
(Inherited from BridgeBase)
ValueGetter Get value setter for the specified data quantity
(Inherited from BridgeBase)
ValueSetter Get value setter for the specified data type
(Inherited from Structure)

Extension Methods

Getter

From the proxy, return an FuncTResult for the specified quantity.

It returns the first quantity of that type that is offered, and null if the quantity is not offered.


(Defined by ProxyExtensions)
Getters Returns a set of FuncTResult for the quantity. We can return several quantities with the same id (usually they will differ in their description). If the quantity is not offerent, an empty list is returned.
(Defined by ProxyExtensions)
GettersFraction Returns a set of FuncT, TResult for the quantity. We can return several quantities with the same id (usually they will differ in their description). If the quantity is not offerent, an empty list is returned.
(Defined by ProxyExtensions)
GetterUnboxed

From the proxy, return an FuncTResult for the specified quantity.

It returns the first quantity of that type that is offered, and null if the quantity is not offered.


(Defined by ProxyExtensions)
Initialize Helper function for some unit tests. Do not use.
(Defined by StructureExtensions)
Initialize Helper function for some unit tests. Do not use.
(Defined by StructureExtensions)
IsSideStructure Returns true if the structure is a side structure
(Defined by StructureExtensions)
Setter

From the proxy, return an IDoubleGetSet for the specified quantity.

It returns the first quantity of that type that is accepted, and null if the quantity is not accepted.


(Defined by ProxyExtensions)

See Also