Click or drag to resize

ICatchmentSourceBoundary Interface

Interface for a CatchmentSourceBoundary. Interfaces for Cathcment ID and scalefactors.

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 ICatchmentSourceBoundary : IBoundarySource, 
	IBoundaryWithComponents

The ICatchmentSourceBoundary type exposes the following members.

Properties
  NameDescription
Public propertyBoundaryID
ID of boundary. Used for searching and connecting sources and items, when required. Not used by the engine.
(Inherited from IBoundarySource.)
Public propertyCatchmentIds
A list of all Catchment ID's associated with this Source. It can be empty, then the source is assumed to be globally valid.
Public propertyCatchmentSourceBoundaryType
CatchmentSource Type - currently only Discharge is implemented
Public propertyComponents
A list of all components sources attached to the source. Each component may include more than one entry in this list.
(Inherited from IBoundaryWithComponents.)
Public propertyModifier
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.

(Inherited from IBoundarySource.)
Top
Methods
  NameDescription
Public methodGetAccumulatedValue(DateTime, DateTime)
Get accumulated value for this source at the given time span
(Inherited from IBoundarySource.)
Public methodGetAccumulatedValue(Int32, DateTime, DateTime)
Get accumulated value for component at given index at the given time span
(Inherited from IBoundaryWithComponents.)
Public methodGetNextTransitionTime
Gets the next time for which there is a different value in the boundary source.
(Inherited from IBoundarySource.)
Public methodGetValue(DateTime)
Get value for this source at the given time
(Inherited from IBoundarySource.)
Public methodGetValue(Int32, DateTime)
Get value for component at given at the given time
(Inherited from IBoundaryWithComponents.)
Public methodGetValueWithoutDWF
Get value for this source at the given time excluding items marked as dry weather flow
(Inherited from IBoundarySource.)
Public methodPrepare
Prepare source.
(Inherited from IBoundarySource.)
Public methodValidate
Validate whether this source is correctly setup
(Inherited from IBoundarySource.)
Top
Extension Methods
  NameDescription
Public Extension MethodFindTimeNextValue
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.)
Top
See Also