IOverFlowGate Methods

Methods

Accepts List of data types that is accepted, i.e., that you can get a ValueSetter for.
(Inherited from IQuantityProxy)
Description Description of the structure.
(Inherited from IStructure)
GetActionInfos List of control action infos, i.e. available control action Id's, their type and unit.
(Inherited from IControllable)
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 IControllable)
GetCurrentValue Get the current value of the control for the specified id.
(Inherited from IControllable)
Initialize Set up structure and set runtime diagnostics object
(Inherited from IStructure)
Offers List of data types that is offered, i.e., that you can get a ValueGetter for.
(Inherited from IQuantityProxy)
Prepare Set up structure and set runtime diagnostics object
(Inherited from IStructure)
ResetControlledState Reset internal state (if any) used by controlling class. Called after a controlling class has performed a control sequence, and simulation is restarted.
(Inherited from IControllable)
SetControlStrategyId Set control strategy id manually
(Inherited from IControllable)
SetWaterLevels Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.
(Inherited from IStructure)
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 IStructure)
Validate Writes errors, warnings and hints into their respective member classes. The member objects are initially cleared.
(Inherited from IStructure)
ValueGetter Get value setter for the specified data quantity
(Inherited from IDoubleProxy)
ValueSetter Get value setter for the specified data type
(Inherited from IDoubleProxy)

Extension Methods

GetControlActionInfo Get control action info for the specified id. It will return null if controlActionId is not valid.
(Defined by StructureExtensions)
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