Click or drag to resize

CatchmentSourceBoundary Methods

The CatchmentSourceBoundary type exposes the following members.

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 accumukated value of the catchment source boundary between the start and end time. The result is set to a negative value for Evaporation and Abstraction boundary types.
(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
Custom ToString - a textual representation of the BoundarySource
(Overrides ObjectToString.)
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
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