DamBreakNWS 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)
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)
Dispose Frees the licenses held.
(Inherited from Structure)
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Finish Finish use of dambreak structure.
(Inherited from DamBreakBase)
GetActionInfos List of control action infos
(Inherited from DamBreakBase)
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 DamBreakBase)
GetCurrentValue Get the current value of the control for the specified id.

Base implementation for IControllable


(Inherited from DamBreakBase)
GetHashCodeServes as the default hash function.
(Inherited from Object)
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
(Overrides DamBreakBaseInitialize(ICrossSection, ICrossSection, Boolean, IDiagnostics))
Offers A list of quantities available from this structure
(Inherited from Structure)
Prepare(HDParameterData, IDiagnostics) Set up structure and set runtime diagnostics object
(Inherited from DamBreakBase)
Prepare(DateTime, HDParameterData, IDiagnostics) Set up structure and set runtime diagnostics object
(Inherited from DamBreakBase)
PrepareTimeStep Prepare structure for time step
(Overrides DamBreakBasePrepareTimeStep(DateTime, DateTime))
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


(Overrides DamBreakBaseResetControlledState)
SetControlStrategyId Set control strategy ID manually.

Base implementation for IControllable


(Inherited from Structure)
Setup 
SetWaterLevels Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.
(Overrides StructureSetWaterLevels(Double, Double))
StartBreach Start the breach now (matching time Np1). This can be called to manually start the breach at a certain time. It must be called in between time steps, and not in the middle of a time step
(Inherited from DamBreakBase)
StartBreach(Int32) Start the breach now (matching time Np1). This can be called to manually start the breach at a certain time. It must be called in between time steps, and not in the middle of a time step
(Inherited from DamBreakBase)
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 Generates errors, warnings.
(Overrides StructureValidate)
ValueGetter Get value setter for the specified data quantity
(Inherited from DamBreakBase)
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