Click or drag to resize

DamBreakNWS Methods

The DamBreakNWS type exposes the following members.

Methods
  NameDescription
Public methodAccepts
List of data types that is accepted, i.e., that you can get a ValueSetter for.
(Inherited from Structure.)
Public methodControlSetFlowFactor
Set flow factor to specified value
(Inherited from Structure.)
Public methodDescription
Return a string that describes this structure. Includes structure type and ID
(Inherited from Structure.)
Public methodDispose
Frees the licenses held.
(Inherited from Structure.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodFinish
Finish use of dambreak structure.
(Inherited from DamBreakBase.)
Public methodGetControlAction
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.)
Public methodGetCurrentValue
Get the current value of the control for the specified id.

Base implementation for IControllable

(Inherited from DamBreakBase.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitialize(IDiagnostics)
Set up structure and set runtime diagnostics object
(Inherited from Structure.)
Public methodInitialize(ICrossSection, ICrossSection, Boolean, IDiagnostics)
Set up structure and set runtime diagnostics object
(Overrides DamBreakBaseInitialize(ICrossSection, ICrossSection, Boolean, IDiagnostics).)
Public methodOffers
A list of quantities available from this structure
(Inherited from Structure.)
Public methodPrepare(HDParameterData, IDiagnostics)
Set up structure and set runtime diagnostics object
(Inherited from DamBreakBase.)
Public methodPrepare(DateTime, HDParameterData, IDiagnostics)
Set up structure and set runtime diagnostics object
(Inherited from DamBreakBase.)
Public methodPrepareTimeStep
Prepare structure for time step
(Overrides DamBreakBasePrepareTimeStep(DateTime, DateTime).)
Public methodResetControlledState
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.)
Public methodSetControlStrategyId
Set control strategy ID manually.

Base implementation for IControllable

(Inherited from Structure.)
Public methodSetup
Public methodSetWaterLevels
Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.
(Overrides StructureSetWaterLevels(Double, Double).)
Public methodStartBreach
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.)
Public methodStartBreach(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.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdatedWaterLevels
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.)
Public methodValidate
Generates errors, warnings.
(Overrides StructureValidate.)
Public methodValueGetter
Get value setter for the specified data quantity
(Inherited from DamBreakBase.)
Public methodValueSetter
Get value setter for the specified data type
(Inherited from Structure.)
Top
Extension Methods
  NameDescription
Public Extension MethodGetter

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.)
Public Extension MethodGetters
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.)
Public Extension MethodGettersFraction
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.)
Public Extension MethodGetterUnboxed

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.)
Public Extension MethodInitialize(CrossSectionData, Boolean, IDiagnostics)Overloaded.
Helper function for some unit tests. Do not use.
(Defined by StructureExtensions.)
Public Extension MethodInitialize(BoundaryData, CrossSectionData, Boolean, IDiagnostics)Overloaded.
Helper function for some unit tests. Do not use.
(Defined by StructureExtensions.)
Public Extension MethodIsSideStructure
Returns true if the structure is a side structure
(Defined by StructureExtensions.)
Public Extension MethodSetter

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.)
Top
See Also