Click or drag to resize

MonthlyBreakdown Class

A type of DatedBreakdown used to specify that degree days should be broken down on a monthly basis and cover a specific Period in time.
Inheritance Hierarchy

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

The MonthlyBreakdown type exposes the following members.

Constructors
  NameDescription
Public methodMonthlyBreakdown(Period)
Constructs a MonthlyBreakdown object that specifies monthly degree days covering the specified period in time and broken down according to regular calendar months.
Public methodMonthlyBreakdown(Period, StartOfMonth)
Constructs a MonthlyBreakdown object that specifies monthly degree days covering the specified period in time, with each "month" starting on the specified day of the month.
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 propertyPeriod
Gets the non-null period in time that the monthly breakdown should cover.
Public propertyStartOfMonth
Gets the StartOfMonth indicating which day should be taken as the first of each month (inclusive).
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 MonthlyBreakdown with the same Period and StartOfMonth 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