RadialGate 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)
ApplyFlowFactor Applies flow factor to discharge and it's derivatives
(Inherited from Structure)
ControlClose Control the gate, close it
(Inherited from Gate)
ControlOpen Control the gate, Open it
(Inherited from Gate)
ControlSetFlowFactor Set flow factor to specified value
(Inherited from Structure)
ControlSetGateLevel Control the gate, set gate level to specified value
(Inherited from Gate)
ControlSetMaxLevel Control the gate, set max gate level to specified value
(Inherited from Gate)
ControlSetMinLevel Control the gate, set min gate level to specified value
(Inherited from Gate)
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)
ExplicitStructureSupport 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)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetActionInfos List of control action infos
(Inherited from Gate)
GetArea 
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 Gate)
GetCurrentValue Get the current value of the control for the specified id.

Base implementation for IControllable


(Inherited from Gate)
GetDepth This function returns the depth above the sill level.
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 GateInitialize(ICrossSection, ICrossSection, Boolean, IDiagnostics))
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Offers A list of quantities available from this structure
(Inherited from Structure)
Prepare(HDParameterData, IDiagnostics)
(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
(Inherited from Gate)
ReadState Read state and apply to module. Returns true if state was successfully read.
(Inherited from Gate)
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 GateResetControlledState)
SetControlStrategyId Set control strategy ID manually.

Base implementation for IControllable


(Inherited from Structure)
SetInputWaterLevels Set the _upstreamWaterLevel, _downstreamWaterLevel and _flowDir
(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)
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 Validation of data for a radial gate.
(Overrides StructureValidate)
ValueGetter Get value setter for the specified data quantity
(Inherited from Gate)
ValueSetter Get value setter for the specified data type
(Inherited from Structure)
WriteState Write current state of module
(Inherited from Gate)

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