DamBreakNWS Methods |
The DamBreakNWS type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Accepts |
List of data types that is accepted, i.e., that you can get a ValueSetter for.
(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.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finish |
Finish use of dambreak structure.
(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.
(Inherited from DamBreakBase.) |
| GetCurrentValue |
Get the current value of the control for the specified id.
(Inherited from DamBreakBase.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Initialize(IStructureCollection, CrossSectionData, Boolean, IDiagnostics) |
Set up structure and set runtime diagnostics object
(Overrides StructureInitialize(IStructureCollection, CrossSectionData, Boolean, IDiagnostics).) |
| Initialize(IStructureCollection, IBoundaryData, CrossSectionData, Boolean, IDiagnostics) |
Set up structure and set runtime diagnostics object
(Overrides DamBreakBaseInitialize(IStructureCollection, IBoundaryData, CrossSectionData, 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.
(Overrides DamBreakBaseResetControlledState.) |
| SetControlStrategyId |
Set control strategy ID manually.
(Inherited from Structure.) |
| SetWaterLevels(Double, Double) |
Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.
(Overrides StructureSetWaterLevels(Double, Double).) |
| SetWaterLevels(Double, Double, DateTime) | (Inherited from Structure.) |
| 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.) |
| ToString | Returns 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.) |
| ValueFractionGetter |
Get value fraction setter for the specified data quantity
(Inherited from DamBreakBase.) |
| ValueGetter |
Get value setter for the specified data quantity
(Inherited from DamBreakBase.) |
| ValueGetterBoxed |
Get value setter for the specified data quantity
(Inherited from Structure.) |
| ValueSetter |
Get value setter for the specified data type
(Inherited from Structure.) |
| ValueSetterBoxed |
Get value setter for the specified data type
(Inherited from Structure.) |
Extension Methods| Name | Description | |
|---|---|---|
 | Description |
Returns the description of the structure, if it is an Structure,
otherwise id + type
(Defined by StructureExtensions.) |
| Getter | From the proxy, return an IDoubleGetter for the specified quantity. It returns the first quantity of that type that is offered, and null if the quantity is not offered. |
| Getters |
Returns a set of IDoubleGetter 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 IDoubleGetter 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 IDoubleGetter for the specified quantity. It returns the first quantity of that type that is offered, and null if the quantity is not offered. |
| Initialize(CrossSectionData, Boolean, IDiagnostics) | Overloaded.
Helper function for some unit tests. Do not use.
(Defined by StructureExtensions.) |
| Initialize(BoundaryData, CrossSectionData, Boolean, IDiagnostics) | Overloaded.
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. |
See Also