Click or drag to resize

CatchmentValueBuffer Class

Class handling buffering and interpolation in time of catchment values.
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.RainfallRunoffModuleCatchmentValueBuffer

Namespace:  DHI.Mike1D.RainfallRunoffModule
Assembly:  DHI.Mike1D.RainfallRunoffModule (in DHI.Mike1D.RainfallRunoffModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class CatchmentValueBuffer : IDoubleTimeProxy

The CatchmentValueBuffer type exposes the following members.

Constructors
  NameDescription
Public methodCatchmentValueBuffer
Default constructor
Top
Properties
  NameDescription
Public propertyStoreFloat
Debug flag, storing floats, to get similar results when running decoupled as live.
Public propertyTimeBuffer
Bool indicating if to buffer in time, or just within the current time step.

If set to true, then the MinTime must be set in order to clean up the buffer accordingly.

Public propertyTimes
Times stored in buffer
Top
Methods
  NameDescription
Public methodCleanupBefore
Dequeue all values older than date, i.e. keep the first one older than date, such that we can do interpolation.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetBuffer
Get the buffer values for buffer at the provided index.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRefreshBuffer
Refresh the buffer with current values. If CurrentTime has changed, the buffers are reset and reloaded (ResetBuffers).
Public methodResetBuffers
Reset the buffer, clear values and add current state to buffer.
Public methodTimeOffers
List of data types that is offered and can be used in GetValue
Public methodTimeValueGetter
Get value getter for the specified data quantity
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdate
Update catchment and buffer to time
Public methodUpdateBuffer
Update buffer with new values from catchment.

To be called at end of every time step.

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 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