Click or drag to resize

DischargeStructure Methods

The DischargeStructure 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.)
Protected methodApplyFlowFactor
Applies flow factor to discharge and it's derivatives
(Inherited from Structure.)
Public methodControlClose
Close gate, set the discharge to zero
Public methodControlOpen
Close gate, set the discharge to max
Public methodControlSetDischarge
Set the discharge to use
Public methodControlSetFlowFactor
Set flow factor to specified value
(Inherited from Structure.)
Public methodControlSetMaxDischarge
Set the maximum discharge allowed when controlling the discharge
Public methodControlSetMinDischarge
Set the minimum discharge allowed when controlling the discharge
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.)
Protected methodExplicitStructureSupport
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.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
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

(Overrides StructureGetControlAction(String).)
Public methodGetCurrentValue
Get the current value of the control for the specified id.

Base implementation for IControllable

(Overrides StructureGetCurrentValue(String).)
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 StructureInitialize(ICrossSection, ICrossSection, Boolean, IDiagnostics).)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
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
(Overrides StructurePrepare(HDParameterData, IDiagnostics).)
Public methodPrepare(DateTime, HDParameterData, IDiagnostics)
Set up structure and set runtime diagnostics object
(Inherited from Structure.)
Public methodPrepareTimeStep
Prepare structure for time step
Public methodReadState
Read state and apply to module. Returns true if state was successfully read.
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 StructureResetControlledState.)
Public methodSetControlStrategyId
Set control strategy ID manually.

Base implementation for IControllable

(Inherited from Structure.)
Protected methodSetInputWaterLevels (Inherited from Structure.)
Public methodSetWaterLevels
Sets up- and down- stream water level. For DischargeGate, SetWaterLevels() does nothing else than implements limits on discharge if _upstreamWaterLevelMinMaxTable != null.
(Overrides StructureSetWaterLevels(Double, Double).)
Protected methodSetZeroFlow
Sets the conditions for zero flow
(Inherited from Structure.)
Public methodToString (Overrides ObjectToString.)
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
Writes errors, warnings and hints into their respective member classes. The member objects are initially cleared.
(Overrides StructureValidate.)
Public methodValueGetter
Get value setter for the specified data quantity
(Overrides StructureValueGetter(Int32).)
Public methodValueSetter
Get value setter for the specified data type
(Inherited from Structure.)
Public methodWriteState
Write current state of module
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