Click or drag to resize

FullYearsAverageBreakdown Class

A type of AverageBreakdown used to specify that average-degree-day figures should be derived from data covering a specified number of full calendar years.
Inheritance Hierarchy
SystemObject
  DegreeDays.Api.DataBreakdown
    DegreeDays.Api.DataAverageBreakdown
      DegreeDays.Api.Data.ImplFullYearsAverageBreakdown

Namespace: DegreeDays.Api.Data.Impl
Assembly: DegreeDays (in DegreeDays.dll) Version: 1.4
Syntax
Copy
public sealed class FullYearsAverageBreakdown : AverageBreakdown

The FullYearsAverageBreakdown type exposes the following members.

Constructors
 NameDescription
Public methodFullYearsAverageBreakdown Constructs a FullYearsAverageBreakdown object that specifies average degree days derived from data covering full calendar years determined by the specified period.
Top
Properties
 NameDescription
Public propertyPeriod Gets the non-null period in time that the breakdown should average data from.
Top
Methods
 NameDescription
Public methodEquals Two Breakdown objects are equal if they have the same class and the same configuration.
(Inherited from Breakdown)
Public methodGetHashCode Overridden to ensure consistency with Equals.
(Inherited from Breakdown)
Public methodToString Returns a non-null, non-empty string representation of this instance for logging and debugging purposes.
(Overrides ObjectToString)
Top
Remarks

The years used will always be consecutive (i.e. no gaps), and are specified using the Period passed into the constructor.

Typically you'd want to use Period.LatestValues(Int32) to create the Period, to specify that the last year of the average should be the most recent full calendar year.

If you want average data calculated using a different method, remember that you can always fetch dated data and calculate averages directly from that.

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