IStructureSourceBoundary Interface |
Interface for a StructureSourceBoundary. Interfaces
for Strucure location.
Namespace: DHI.Mike1D.BoundaryModule
Assembly: DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe IStructureSourceBoundary type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | BoundaryID |
ID of boundary. Used for searching and connecting sources and items, when required. Not used by the engine.
(Inherited from IBoundarySource.) |
| 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.) |
| Location |
A list of all Structure ID's associated with this Source. It can be empty, then
the source is assumed to be globally valid.
|
| 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.
(Inherited from IBoundarySource.)Default is null The value is provided in the engine unit and must be returned in the engine unit. |
| StructureId |
ID of the structure that this boundary connects to
|
| StructureSourceBoundaryType |
Structure boundary time
|
Methods| Name | Description | |
|---|---|---|
 | GetAccumulatedValue(DateTime, DateTime) |
Get accumulated value for this source at the given time span
(Inherited from IBoundarySource.) |
| 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.
(Inherited from IBoundarySource.) |
| GetValue(DateTime) |
Get value for this source at the given time
(Inherited from IBoundarySource.) |
| 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
(Inherited from IBoundarySource.) |
| Prepare |
Prepare source.
(Inherited from IBoundarySource.) |
| Validate |
Validate whether this source is correctly setup
(Inherited from IBoundarySource.) |
Extension Methods| Name | Description | |
|---|---|---|
 | 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.) |
See Also