Pump Methods |
The Pump 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.) |
 | ApplyFlowFactor |
Applies flow factor to discharge and it's derivatives
(Inherited from Structure.) |
| ControlResume |
Resume the pump to normal operation.
|
| ControlSetDischarge |
Set discharge for pump explicitly.
Pump acceleration parameters will be used, so pump may take a while to obtain the desired discharge. If the pump is stopped, this will resume pump operation. |
| ControlSetFlowFactor |
Set flow factor to specified value
(Inherited from Structure.) |
| ControlSetStartLevel |
Set new start level
If the pump is stopped, this will resume pump operation. |
| ControlSetStartStopLevel |
Set new start/stop level
If the pump is stopped, this will resume pump operation. |
| ControlSetStopLevel |
Set new stop level
If the pump is stopped, this will resume pump operation. |
| ControlShutDown |
Stop the pump immediately, no deceleration time.
The pump will be inactive until ControlResume(Int32) or one of the other Control method is called explicitly. |
| ControlStop |
Stop and suspend the pump.
If a deceleration time is specified, the pump will initiate a deceleration and be completely stopped after this time. The pump will be inactive until ControlResume(Int32) or one of the other Control method is called explicitly. |
| 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.) |
| ExplicitStructureSupport |
DEBUG: This method is called from Prepare() if _implitcit == false to check if
the structure supports being Explicit.
Once all structures support explicit operation this method can be deleted.
(Overrides StructureExplicitStructureSupport.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetControlAction |
If an entity implements the IControllable interface it can be controlled by
the ControlModule.
(Overrides StructureGetControlAction(String).) |
| GetCurrentValue |
If an entity implements the IControllable interface it can be controlled by
the ControlModule.
(Overrides StructureGetCurrentValue(String).) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets 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 StructureInitialize(ICrossSection, ICrossSection, Boolean, IDiagnostics).) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Offers |
A list of quantities available from this structure
(Inherited from Structure.) |
| PreferredDt |
The preferred time span for the next time step. Used when adaptive time stepping is active.
|
| Prepare(HDParameterData, IDiagnostics) |
Set up structure and set runtime diagnostics object
(Overrides StructurePrepare(HDParameterData, IDiagnostics).) |
| Prepare(DateTime, HDParameterData, IDiagnostics) |
Set up structure and set runtime diagnostics object
(Inherited from Structure.) |
| PrepareTimeStep |
Prepare structure for time step
|
| ReadState |
Read state and apply to module.
Returns true if state was successfully read.
|
| ResetControlledState |
If an entity implements the IControllable interface it can be controlled by
the ControlModule.
(Overrides StructureResetControlledState.) |
| SetControlStrategyId |
Set control strategy ID manually.
(Inherited from Structure.)Base implementation for IControllable |
| SetInputWaterLevels | (Inherited from Structure.) |
| SetWaterLevels |
Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.
(Overrides StructureSetWaterLevels(Double, Double).) |
| SetZeroFlow |
Sets the conditions for zero flow
(Inherited from Structure.) |
| 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 |
Writes errors, warnings and hints into their respective member classes. The member objects are initially cleared.
(Overrides StructureValidate.) |
| ValueGetter |
Get value setter for the specified data quantity
(Overrides StructureValueGetter(Int32).) |
| ValueSetter |
Get value setter for the specified data type
(Inherited from Structure.) |
| WriteState |
Write current state of module
|
Extension Methods| Name | Description | |
|---|---|---|
 | 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. |
| 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. |
| 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.) |
| IsPumpReversed |
Check if pump is reversed, i.e. the pump is a DeltaHQTable
and the HQRelation has negative values.
(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