Average |
Contains a set of average degree-day data generated to fulfil an
AverageDataSpec for a specific Location.
Inheritance HierarchyNamespace: DegreeDays.Api.Data
Assembly: DegreeDays (in DegreeDays.dll) Version: 1.4
SyntaxThe AverageDataSet type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AnnualAverage | Gets the non-null average annual value. |
| FirstYear | Gets the first year of the continuous set of data that was used to calculate the average figures. |
| FullRange |
Gets the DayRange indicating the period of
data from which this AverageDataSet's figures were
calculated.
(Overrides DataSetBaseFullRange) |
| LastYear | Gets the last year of the continuous set of data that was used to calculate the average figures. |
| NumberOfYears | Gets the number of years of data that the average figures were calculated from (e.g. for 5-year-average data this would return 5). |
| PercentageEstimated |
Gets the number between 0 and 100 (both inclusive) indicating the
overall extent to which this data set is based on estimated
data.
(Overrides DataSetBasePercentageEstimated) |
Methods| Name | Description | |
|---|---|---|
 | Equals |
Returns true if obj is an
AverageDataSet containing equal values and calculated from
data covering an equal period in time.
(Overrides ObjectEquals(Object)) |
| GetHashCode |
Overridden to ensure consistency with Equals.
(Overrides ObjectGetHashCode) |
| MonthlyAverage | Returns the non-null average value for the specified month (e.g. pass 1 for the average value for the month of January). |
| ToString |
Returns a non-null, non-empty string representation of this instance for logging and debugging purposes.
(Overrides ObjectToString) |
RemarksSee AverageDataSpec for example code showing how to fetch an AverageDataSet of average degree days from the API.
Thread Safety
Instances of this class are immutable. You can safely reuse them and call them from multiple threads at once.
See Also