AverageBreakdownFullYears Method

Returns a non-null FullYearsAverageBreakdown object that specifies average degree days derived from data covering full calendar years determined by the specified period.

Namespace: DegreeDays.Api.Data
Assembly: DegreeDays (in DegreeDays.dll) Version: 1.4

Syntax

Copy

public static FullYearsAverageBreakdown FullYears(
	Period period
)

Public Shared Function FullYears ( 
	period As Period
) As FullYearsAverageBreakdown

Parameters

period Period: Specifies the full calendar years of data that the average figures should be derived from. Cannot be null. Typically you'd want to use Period.LatestValues(Int32) for this, specifying at least 2 values (since an average of 1 year of data is not very meaningful). But you can also use Period.DayRange(DayRange) - in this case the period may be widened for calculation purposes to make it cover full calendar years. (See these remarks for more on widening.)

Return Value

FullYearsAverageBreakdown
The newly-constructed FullYearsAverageBreakdown object.

Exceptions

Exception	Condition
ArgumentNullException	period is null.

Reference

AverageBreakdown Class

DegreeDays.Api.Data Namespace