CatchmentValueBuffer Class

Class handling buffering and interpolation in time of catchment values.

Definition

Namespace: DHI.Mike1D.RainfallRunoffModule
Assembly: DHI.Mike1D.RainfallRunoffModule (in DHI.Mike1D.RainfallRunoffModule.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class CatchmentValueBuffer : IDoubleTimeProxy, 
	IModelStateReadWrite
Inheritance
Object    CatchmentValueBuffer
Implements
IDoubleTimeProxy, IModelStateReadWrite

Constructors

CatchmentValueBuffer Default constructor

Properties

StoreFloat Debug flag, storing floats, to get similar results when running decoupled as live.
TimeBuffer 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.

Times Times stored in buffer

Methods

CleanupBefore Dequeue all values older than date, i.e. keep the first one older than date, such that we can do interpolation.
Clear Clear the buffer
CreateOrClear Create a new buffer if input buffer is null or number of offers changed. Otherwise clear the input buffer.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetBuffer Get the buffer values for buffer at the provided index.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ReadState Read state and apply to module. Returns true if state was successfully read.
RefreshBuffer Refresh the buffer with current values. If CurrentTime has changed, the buffers are reset and reloaded (ResetBuffers).
ResetBuffers Reset the buffer, clear values and add current state to buffer.
TimeOffers List of data types that is offered and can be used in GetValue
TimeOffersSurface List of data types that is offered by the catchment surface and can be used in GetValue.
TimeValueGetter Get value getter for the specified data quantity
TimeValueGetterSurface Get value getter for the specified data quantity for the catchment surface.
ToStringReturns a string that represents the current object.
(Inherited from Object)
Update Update catchment and buffer to time
UpdateBuffer Update buffer with new values from catchment.

To be called at end of every time step.

WriteState Write current state of module

Extension Methods

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

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)

See Also