Click or drag to resize

ICatchment Methods

The ICatchment 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 methodInitialize
Initialize Rainfall Runoff model. Sets up static data.
Public methodInitializePlugins
Initializes the cathcment plugins.
Public methodOffers
List of data types that is offered, i.e., that you can get a ValueGetter for.
(Inherited from IQuantityProxy.)
Public methodPerformTimeStep
This procedure forwards the calculation with one time step.
Public methodPrepare
Prepare Rainfall Runoff model. Sets up dynamic data so that the model is ready for first time step.
Public methodPreparePlugins
Prepares the cathcment plugins.
Public methodResetBoundaries
Remove boundaries applied in previous runs
Public methodTimeOffers
List of data types that is offered and can be used in GetValue
(Inherited from IDoubleTimeProxy.)
Public methodTimeOfNextUpdate Obsolete.
Return the time of next update. Used for PostTimeStepEvent event in Catchments.
Public methodTimeValueGetter
Get value getter for the specified data quantity
(Inherited from IDoubleTimeProxy.)
Public methodType
Type of model used in catchment
Public methodUpdate
This procedure forwards the calculation such that the state includes the specified time
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(IQuantity)Overloaded.

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 MethodGetter(IQuantity, IQuantity)Overloaded.

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 MethodNTSGeometry
Create an NTS geometry from the CatchmentGeometry.

Depending on the coordinates, the returned IGeometry is either a NTS Polygon or NTS MultiPolygon.

(Defined by RRExtensions.)
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.)
Public Extension MethodTimeValueGetter

From the proxy, return an FuncT, TResult 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.)
Top
See Also