Click or drag to resize

IOrifice Methods

The IOrifice 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 IQuantityProxy.)
Public methodDescription
Description of the structure.
(Inherited from IStructure.)
Public methodInitialize
Set up structure and set runtime diagnostics object
(Inherited from IStructure.)
Public methodOffers
List of data types that is offered, i.e., that you can get a ValueGetter for.
(Inherited from IQuantityProxy.)
Public methodPrepare
Set up structure and set runtime diagnostics object
(Inherited from IStructure.)
Public methodPrepareForGate
Set orifice discharge for al positions of the gate. If a control is active (a weir or gate is present) then this must be called after: 1) Prepare() 2) Gate polygons have been defined 3) MaxGateLevel and MinGateLevel have been set.

This is called automatically in prepare. It must be called explicitly if gate polygons or max/min gate level are changed after the prepare step

Public methodSetWaterLevels
Sets up- and down- stream water level and forces the calculation of the discharge and its derivatives.
(Inherited from IStructure.)
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 IStructure.)
Public methodValidate
Writes errors, warnings and hints into their respective member classes. The member objects are initially cleared.
(Inherited from IStructure.)
Public methodValueGetter
Get value setter for the specified data quantity
(Inherited from IDoubleProxy.)
Public methodValueSetter
Get value setter for the specified data type
(Inherited from IDoubleProxy.)
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