Click or drag to resize

AbstractSourceBoundary Methods

The AbstractSourceBoundary 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.

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
Public methodGetAccumulatedValue(Int32, DateTime, DateTime)
Get accumulated value for component at given index at the given time span
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.
Public methodGetNextTransitionTime
Gets the next time for which there is a different value in the boundary source.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue(DateTime)
Get value for this source
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.

Public methodGetValueWithoutDWF
Get value for this source without items marked as dry weather flow
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepare
Prepare source.
Protected methodStatic memberPrepareComponents
Prepare AD components. Called as part of Prepare(DateTime, DateTime, IDiagnostics).
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
Protected methodStatic memberTryModify(BoundarySourceComponent, Double, DateTime)
Try modify boundary value, if Modifier is not null
Public methodValidate
Validate whether this source is correctly setup
Protected methodValidateItems
Validate _iItems of BoundarySource
Public methodStatic memberValidateItemsInSimTime
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.

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