Click or drag to resize

TimeSeriesDataSet Class

Contains a set of time-series data (e.g. hourly temperature data) generated to fulfil a TimeSeriesDataSpec for a specific Location.
Inheritance Hierarchy

Namespace:  DegreeDays.Api.Data
Assembly:  DegreeDays (in DegreeDays.dll) Version: 1.3
Syntax
public sealed class TimeSeriesDataSet : DataSetBase

The TimeSeriesDataSet type exposes the following members.

Properties
  NameDescription
Public propertyFullRange
Gets the DayRange indicating the period of time that is covered by this TimeSeriesDataSet's Values.
(Overrides DataSetBaseFullRange.)
Public propertyPercentageEstimated
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.)
Public propertyValues
Gets the non-null, non-empty, chronologically-ordered list of TimeSeriesDataValue objects that make up this TimeSeriesDataSet.
Top
Methods
  NameDescription
Public methodEquals(Object)
Returns true if obj is a TimeSeriesDataSet containing equal values and with an equal PercentageEstimated.
(Overrides ObjectEquals(Object).)
Public methodGetHashCode
Overridden to ensure consistency with Equals.
(Overrides ObjectGetHashCode.)
Public methodGetValuesWithin(Day)
Returns a non-null, possibly-empty, chronologically-ordered list of the TimeSeriesDataValue objects from this TimeSeriesDataSet that fall within the specified Day.
Public methodGetValuesWithin(DayRange)
Returns a non-null, possibly-empty, chronologically-ordered list of the TimeSeriesDataValue objects from this TimeSeriesDataSet that fall within the specified DayRange.
Public methodToString
Returns a non-null, non-empty string representation of this instance for logging and debugging purposes.
(Overrides ObjectToString.)
Top
Remarks

See TimeSeriesDataSpec for example code showing how to get a TimeSeriesDataSet of hourly temperature data from the API.

Thread Safety
Instances of this class are immutable. You can safely reuse them and call them from multiple threads at once.
Version History
VersionDescription
1.2 This was added in version 1.2.
See Also