Click or drag to resize
AverageBreakdown Class

Defines how a set of average degree days should be broken down, including the period in time they should cover.

Inheritance Hierarchy

Namespace: DegreeDays.Api.Data
Assembly: DegreeDaysApi (in DegreeDaysApi.dll) Version: 1.1.0.0 (1.1.0.0)
Syntax
public abstract class AverageBreakdown : Breakdown

The AverageBreakdown type exposes the following members.

Methods
  NameDescription
Public methodEquals
Two Breakdown objects are equal if they have the same class and the same configuration.
(Inherited from Breakdown.)
Public methodStatic memberFullYears
Returns a non-null FullYearsAverageBreakdown object that specifies average degree days derived from data covering full calendar years determined by the specified period.
Public methodGetHashCode
Overridden to ensure consistency with Equals.
(Inherited from Breakdown.)
Top
Remarks

This is the abstract superclass of the types of Breakdown that can be taken by an AverageDataSpec.

To create an AverageBreakdown object use the FullYears(Period) static factory method. For example:

AverageBreakdown fiveYearAverage = 
    AverageBreakdown.FullYears(Period.LatestValues(5));

This abstract class is not designed to be extended by third-party code, which is why it does not have an accessible constructor.

Thread Safety
All concrete subclasses of this abstract class are immutable. You can safely reuse them and call them from multiple threads at once.
See Also