Click or drag to resize

DatedDataValueCreate(Double, Double, Day) Method

Returns a non-null DatedDataValue object with the specified value and percentage estimated, and covering just the specified Day.

Namespace: DegreeDays.Api.Data
Assembly: DegreeDays (in DegreeDays.dll) Version: 1.4
Syntax
Copy
public static DatedDataValue Create(
	double value,
	double percentageEstimated,
	Day singleDay
)

Parameters

value  Double
Indicating the value to be held by the returned object (i.e. the degree days).
percentageEstimated  Double
A number, greater than or equal to zero and less than or equal to 100, indicating the extent to which the value is based on estimated data.
singleDay  Day
The Day that the value covers.

Return Value

DatedDataValue
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptionvalue is infinity, or if percentageEstimated is less than 0 or greater than 100. At the moment an ArgumentOutOfRangeException will also be thrown if value is less than zero (since degree-day values are always zero or greater), but this may change in the future if this class is used for other types of data.
ArgumentExceptionvalue or percentageEstimated is NaN.
Remarks

The returned DatedDataValue will be equal to the DatedDataValue that would be returned if you called Create(Double, Double, DayRange) passing a DayRange that covered the same single Day only.

See Also