Click or drag to resize

WeeklyBreakdown Class

A type of DatedBreakdown used to specify that degree days should be broken down on a weekly basis and cover a specific Period in time, with weeks starting on a specific day of the week.
Inheritance Hierarchy

Namespace:  DegreeDays.Api.Data.Impl
Assembly:  DegreeDays (in DegreeDays.dll) Version: 1.3
Syntax
public sealed class WeeklyBreakdown : DatedBreakdown

The WeeklyBreakdown type exposes the following members.

Constructors
  NameDescription
Public methodWeeklyBreakdown(Period, DayOfWeek)
Constructs a WeeklyBreakdown object that specifies weekly degree days covering the specified period in time, with each "week" starting on the specified day of the week.
Top
Properties
  NameDescription
Public propertyAllowPartialLatest
Returns true if the latest day range can be partially filled (i.e. incomplete); false otherwise (the default case).
(Inherited from DatedBreakdown.)
Public propertyFirstDayOfWeek
Gets the day of the week that should be the first of each weekly period.
Public propertyPeriod
Gets the non-null period in time that the weekly breakdown should cover.
Top
Methods
  NameDescription
Public methodEquals(Object)
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.)
Public methodWithAllowPartialLatest(Boolean)
Returns a WeeklyBreakdown with the same Period and FirstDayOfWeek as this, but with the AllowPartialLatest property set to the specified value.
Top
Thread Safety
Instances of this class are immutable. You can safely reuse them and call them from multiple threads at once.
See Also