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.4

Syntax

public sealed class YearlyBreakdown : DatedBreakdown

Public NotInheritable Class YearlyBreakdown
	Inherits DatedBreakdown

The YearlyBreakdown type exposes the following members.

Constructors

	Name	Description
	YearlyBreakdown(Period)	Constructs a YearlyBreakdown object that specifies yearly degree days covering the specified period in time and broken down according to regular calendar years.
	YearlyBreakdown(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.

Properties

	Name	Description
	AllowPartialLatest	Returns true if the latest day range can be partially filled (i.e. incomplete); false otherwise (the default case). (Inherited from DatedBreakdown)
	Period	Gets the non-null period in time that the yearly breakdown should cover.
	StartOfYear	Gets the StartOfYear indicating which day should be taken as the first of each year (inclusive).

Methods

	Name	Description
	Equals	Two Breakdown objects are equal if they have the same class and the same configuration. (Inherited from Breakdown)
	GetHashCode	Overridden to ensure consistency with Equals. (Inherited from Breakdown)
	ToString	Returns a non-null, non-empty string representation of this instance for logging and debugging purposes. (Overrides ObjectToString)
	WithAllowPartialLatest	Returns a YearlyBreakdown with the same Period and StartOfYear as this, but with the AllowPartialLatest property set to the specified value.

Thread Safety

Instances of this class are immutable. You can safely reuse them and call them from multiple threads at once.