GlobalGeoLocatedSource Class

A global source that has a geographical position associated with it.

A global source can have several geo-located sources, and the closest geo-located source can be used.

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 class GlobalGeoLocatedSource : AbstractSourceBoundary
Inheritance
Object    AbstractSourceBoundary    GlobalGeoLocatedSource

Constructors

Properties

BoundaryID ID of boundary
(Inherited from AbstractSourceBoundary)
BoundarySourceType Returns the boundary source type of the boundary
(Overrides AbstractSourceBoundaryBoundarySourceType)
Components A list of all components sources attached to the source. Each component may have more than one entry in this list.
(Inherited from AbstractSourceBoundary)
GeoPoint Point/position where source is located.

If there is only one geo-located source in the global item, the GeoPoint may be null.

GlobalSourceBoundaryType Type of global source boundary
Items A list of all items attached to the source
(Inherited from AbstractSourceBoundary)
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.


(Inherited from AbstractSourceBoundary)

Methods

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.


(Inherited from AbstractSourceBoundary)
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows 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
(Overrides AbstractSourceBoundaryGetAccumulatedValue(DateTime, DateTime))
GetAccumulatedValue(DateTime, DateTime, TimeSpan) Get accumulated value, and the span for which the values are not delete values.
(Inherited from AbstractSourceBoundary)
GetAccumulatedValue(Int32, DateTime, DateTime) Get accumulated value for component at given index at the given time span
(Inherited from AbstractSourceBoundary)
GetDeleteValue Return the delete value for this boundary.
(Overrides AbstractSourceBoundaryGetDeleteValue)
GetHashCodeServes 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.
(Inherited from AbstractSourceBoundary)
GetNextTransitionTime Gets the next time for which there is a different value in the boundary source.
(Inherited from AbstractSourceBoundary)
GetTypeGets the Type of the current instance.
(Inherited from Object)
GetValue(DateTime) Get value for this source
(Overrides AbstractSourceBoundaryGetValue(DateTime))
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.


(Inherited from AbstractSourceBoundary)
GetValueWithoutDWF Get value for this source without items marked as dry weather flow
(Inherited from AbstractSourceBoundary)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Prepare Prepare source.
(Inherited from AbstractSourceBoundary)
ToStringReturns a string that represents the current object.
(Inherited from Object)
TryModify(Double, DateTime) Try modify boundary value, if Modifier is not null
(Inherited from AbstractSourceBoundary)
Validate Validate whether this source is correctly setup
(Inherited from AbstractSourceBoundary)
ValidateItems Validate _iItems of BoundarySource
(Inherited from AbstractSourceBoundary)

Fields

_boundaryID See BoundaryID
(Inherited from AbstractSourceBoundary)
_iItems A list of all items attached to the source
(Inherited from AbstractSourceBoundary)

See Also