AbstractSourceBoundary Class |
- OpenSourceBoundary
- PointSourceBoundary
- DistributedSourceBoundary
- GlobalGeoLocatedSource
- StructureSourceBoundary
- CatchmentSourceBoundary
- CatchmentComponentSourceBoundary
The AbstractSourceBoundary has a list of boundary items, Items
Inheritance HierarchyNamespace: DHI.Mike1D.BoundaryModule
Assembly: DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe AbstractSourceBoundary type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AbstractSourceBoundary | Initializes a new instance of the AbstractSourceBoundary class |
Properties| Name | Description | |
|---|---|---|
 | BoundaryID |
ID of boundary
|
| BoundarySourceType |
Returns the boundary source type of the boundary
|
| Components |
A list of all components sources attached to the source. Each component may have more than
one entry in this list.
|
| Items |
A list of all items attached to the source
|
| 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| Name | Description | |
|---|---|---|
| CalculateVariation |
Calculate variation (as difference from linear interpolation between start and end)
This method estimates the variation by checking values at 3 intermediate points within the interval. Since this looks up in the time series 5 times, there may be performance issues with this, so use with care. |
 | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| 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
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetNextComponentTransitionTime |
Gets the next time for which there is a different value in the component boundary source.
|
| GetNextTransitionTime |
Gets the next time for which there is a different value in the boundary source.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetValue(DateTime) |
Get value for this source
|
| GetValue(Int32, DateTime) |
Get value of the component in the boundary on the provided index.
The index is NOT into global index of AD components. |
| GetValueWithoutDWF |
Get value for this source without items marked as dry weather flow
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Prepare |
Prepare source.
|
 | PrepareComponents |
Prepare AD components. Called as part of Prepare(DateTime, DateTime, IDiagnostics).
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TryModify(Double, DateTime) |
Try modify boundary value, if Modifier is not null
|
| TryModify(BoundarySourceComponent, Double, DateTime) |
Try modify boundary value, if Modifier is not null
|
| Validate |
Validate whether this source is correctly setup
|
| ValidateItems |
Validate _iItems of BoundarySource
|
| ValidateItemsInSimTime |
Validate that the source has boundary items covering from start to end time.
Returns the type of data missing. In case of Start, the firstMiss will contain the start time of the data in the source. In case of Middle and End, the firstMiss will contain the time of the first missing data. In case simStart is MinValue or simEnd is MaxValue, no validation will take place and Unknown will be returned. |
Fields| Name | Description | |
|---|---|---|
 | _boundaryID | See BoundaryID |
| _iItems |
A list of all items attached to the source
|
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 AlsoReference
Inheritance HierarchyDHI.Mike1D.BoundaryModuleAbstractSourceBoundary
DHI.Mike1D.BoundaryModuleAbstractLocationSourceBoundary
DHI.Mike1D.BoundaryModuleCatchmentComponentSourceBoundary
DHI.Mike1D.BoundaryModuleCatchmentSourceBoundary
DHI.Mike1D.BoundaryModuleDistributedSourceBoundary
DHI.Mike1D.BoundaryModuleGlobalGeoLocatedSource
DHI.Mike1D.BoundaryModuleStructureSourceBoundary