Click or drag to resize

IBoundaryItem Interface

A general BoundaryItem interface. AbstractBoundaryItem provides a general implementation of IBoundaryItem.

Namespace:  DHI.Mike1D.BoundaryModule
Assembly:  DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public interface IBoundaryItem

The IBoundaryItem type exposes the following members.

Properties
  NameDescription
Public propertyEumQuantity
EUM quantity of boundary item.

Used for validation and in AD also for unit conversion.

Public propertyIsDryWeatherFlow
Boundary items can be marked as "dry weather flow" (used in MIKE URBAN). This is used in Long Term Simulation to exclude dry weather flow from the total inflow when evaluating how to start a new LTS job (if selecting a new hot start file)

This flag has no effect on the simulation, only on LTS job evaluations.

Top
Methods
  NameDescription
Public methodGetAccumulatedValue

Get boundary value accumulated over the specified period.

It is the callers responsibility to check if the item is applicable at the given datetime before calling GetAccumulatedValue.

If the item is only applicable over a part of the interval, it must return the accumulated value for that part of the interval.

Public methodGetNextTransitionTime
Gets the next time for which there is a different value in the boundary item.
Public methodGetValue

Get boundary value at specified date/time.

It is the callers responsibility to check if the item is applicable at the given datetime before calling GetValue.

Public methodIsApplicable(DateTime)
Checks whether the item is applicable at the given datetime.
Public methodIsApplicable(DateTime, DateTime)
Checks whether the item is applicable at the given time interval. It returns true also if the item covers only a part of the start-end interval
Public methodPrepare
Prepare item for simulation.
Public methodValidate
Validate this
Top
See Also