Click or drag to resize

YearlyBreakdown Class

A type of DatedBreakdown used to specify that degree days should be broken down on a yearly (annual) 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 YearlyBreakdown : DatedBreakdown

The YearlyBreakdown type exposes the following members.

Constructors
  NameDescription
Public methodYearlyBreakdown(Period)
Constructs a YearlyBreakdown object that specifies yearly degree days covering the specified period in time and broken down according to regular calendar years.
Public methodYearlyBreakdown(Period, StartOfYear)
Constructs a 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
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 yearly breakdown should cover.
Public propertyStartOfYear
Gets the StartOfYear indicating which day should be taken as the first of each year (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 YearlyBreakdown with the same Period and StartOfYear 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