Click or drag to resize

DatedBreakdown Class

Defines how a set of dated degree days should be broken down, including the period in time they should cover.
Inheritance Hierarchy
SystemObject
  DegreeDays.Api.DataBreakdown
    DegreeDays.Api.DataDatedBreakdown
      More

Namespace: DegreeDays.Api.Data
Assembly: DegreeDays (in DegreeDays.dll) Version: 1.4
Syntax
Copy
public abstract class DatedBreakdown : Breakdown

The DatedBreakdown type exposes the following members.

Properties
 NameDescription
Public propertyAllowPartialLatest Returns true if the latest day range can be partially filled (i.e. incomplete); false otherwise (the default case).
Top
Methods
 NameDescription
Public methodStatic memberCustom Returns a non-null CustomBreakdown object that specifies degree days broken down to match the DayRanges passed in.
Public methodStatic memberDaily Returns a non-null DailyBreakdown object that specifies daily degree days covering the specified period in time.
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 methodStatic memberMonthly(Period) Returns a non-null MonthlyBreakdown object that specifies monthly degree days covering the specified period in time and broken down according to regular calendar months.
Public methodStatic memberMonthly(Period, StartOfMonth) Returns a non-null MonthlyBreakdown object that specifies monthly degree days covering the specified period in time, with each "month" starting on the specified day of the month.
Public methodStatic memberWeekly Returns a non-null WeeklyBreakdown object that specifies weekly degree days covering the specified period in time, with each "week" starting on the specified day of the week.
Public methodStatic memberYearly(Period) Returns a non-null YearlyBreakdown object that specifies yearly degree days covering the specified period in time and broken down according to regular calendar years.
Public methodStatic memberYearly(Period, StartOfYear) Returns a non-null YearlyBreakdown object that specifies yearly degree days covering the specified period in time, with each "year" starting on the specified day of the year.
Top
Remarks

This is the abstract superclass of the types of Breakdown that can be taken by a DatedDataSpec.

To create a DatedBreakdown object you can use the static factory methods of this class. For example:

Copy
DatedBreakdown dailyBreakdownOverLast30Days = 
    DatedBreakdown.Daily(Period.LatestValues(30));

DatedBreakdown weeklyBreakdownFor2024WithWeeksStartingOnMonday = 
    DatedBreakdown.Weekly(
        Period.DayRange(new Day(2024, 1, 1).To(2024, 12, 31)),
        DayOfWeek.Monday);

DatedBreakdown monthlyBreakdownOverLast12Months = 
    DatedBreakdown.Monthly(Period.LatestValues(12));

DatedBreakdown yearlyBreakdownOverLast5Years =
    DatedBreakdown.Yearly(Period.LatestValues(5));

As you can see from the above examples, defining the Period is an important part of defining a DatedBreakdown. See that class for more information on the relevant options.

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
Inheritance Hierarchy