IOrifice Methods |
The IOrifice 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 IQuantityProxy.) |
| Description |
Description of the structure.
(Inherited from IStructure.) |
| 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.) |
| PrepareForGate |
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 |
| 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| 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.) |
| 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