IBoundarySource Interface

Base interface for all BoundarySources

Definition

Namespace: DHI.Mike1D.BoundaryModule
Assembly: DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public interface IBoundarySource : IBoundaryWithComponents
Implements
IBoundaryWithComponents

Properties

BoundaryID ID of boundary. Used for searching and connecting sources and items, when required. Not used by the engine.
Components A list of all components sources attached to the source. Each component may include more than one entry in this list.
(Inherited from IBoundaryWithComponents)
Modifier A modifier that you can assign run-time to the setup, to handle e.g. putting noise to the model or in other ways change the value.

Default is null

The value is provided in the engine unit and must be returned in the engine unit.

Methods

GetAccumulatedValue(DateTime, DateTime) Get accumulated value for this source at the given time span
GetAccumulatedValue(Int32, DateTime, DateTime) Get accumulated value for component at given index at the given time span
(Inherited from IBoundaryWithComponents)
GetNextTransitionTime Gets the next time for which there is a different value in the boundary source.
GetValue(DateTime) Get value for this source at the given time
GetValue(Int32, DateTime) Get value for component at given at the given time
(Inherited from IBoundaryWithComponents)
GetValueWithoutDWF Get value for this source at the given time excluding items marked as dry weather flow
Prepare Prepare source.
Validate Validate whether this source is correctly setup

Extension Methods

FindTimeNextValue Findes the time where the boundary source has a value that is non-zero. The time interval is within the provided limits.
(Defined by BoundaryExtensions)
GetAccumulatedValue Method for IBoundarySource to support items implementing GetAccumulatedValue(DateTime, DateTime, TimeSpan)
(Defined by BoundaryExtensions)

See Also