Click or drag to resize

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.

Inheritance Hierarchy

Namespace:  DHI.Mike1D.BoundaryModule
Assembly:  DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class GlobalGeoLocatedSource : AbstractSourceBoundary

The GlobalGeoLocatedSource type exposes the following members.

Constructors
  NameDescription
Public methodGlobalGeoLocatedSource
Constructor
Top
Properties
  NameDescription
Public propertyBoundaryID
ID of boundary
(Inherited from AbstractSourceBoundary.)
Public propertyBoundarySourceType
Returns the boundary source type of the boundary
(Overrides AbstractSourceBoundaryBoundarySourceType.)
Public propertyComponents
A list of all components sources attached to the source. Each component may have more than one entry in this list.
(Inherited from AbstractSourceBoundary.)
Public propertyGeoPoint
Point/position where source is located.

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

Public propertyGlobalSourceBoundaryType
Type of global source boundary
Public propertyItems
A list of all items attached to the source
(Inherited from AbstractSourceBoundary.)
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 AbstractSourceBoundary.)
Top
Methods
  NameDescription
Protected methodCalculateVariation
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.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetAccumulatedValue(DateTime, DateTime)
Get accumulated value for this source at the given time span
(Overrides AbstractSourceBoundaryGetAccumulatedValue(DateTime, DateTime).)
Public methodGetAccumulatedValue(Int32, DateTime, DateTime)
Get accumulated value for component at given index at the given time span
(Inherited from AbstractSourceBoundary.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetNextComponentTransitionTime
Gets the next time for which there is a different value in the component boundary source.
(Inherited from AbstractSourceBoundary.)
Public methodGetNextTransitionTime
Gets the next time for which there is a different value in the boundary source.
(Inherited from AbstractSourceBoundary.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue(DateTime)
Get value for this source
(Overrides AbstractSourceBoundaryGetValue(DateTime).)
Public methodGetValue(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.)
Public methodGetValueWithoutDWF
Get value for this source without items marked as dry weather flow
(Inherited from AbstractSourceBoundary.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepare
Prepare source.
(Inherited from AbstractSourceBoundary.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodTryModify(Double, DateTime)
Try modify boundary value, if Modifier is not null
(Inherited from AbstractSourceBoundary.)
Public methodValidate
Validate whether this source is correctly setup
(Overrides AbstractSourceBoundaryValidate(DateTime, DateTime).)
Protected methodValidateItems
Validate _iItems of BoundarySource
(Inherited from AbstractSourceBoundary.)
Top
Fields
  NameDescription
Protected field_boundaryID (Inherited from AbstractSourceBoundary.)
Protected field_iItems
A list of all items attached to the source
(Inherited from AbstractSourceBoundary.)
Top
See Also