CustomBreakdown Class

A type of DatedBreakdown used to specify that degree days should be broken down into the custom date ranges specified e.g. to match the dates of your energy-usage records.

Inheritance Hierarchy

SystemObject
  DegreeDays.Api.DataBreakdown
    DegreeDays.Api.DataDatedBreakdown
      DegreeDays.Api.Data.ImplCustomBreakdown

Namespace: DegreeDays.Api.Data.Impl
Assembly: DegreeDays (in DegreeDays.dll) Version: 1.4

Syntax

Copy

public sealed class CustomBreakdown : DatedBreakdown

Public NotInheritable Class CustomBreakdown
	Inherits DatedBreakdown

The CustomBreakdown type exposes the following members.

Constructors

	Name	Description
	CustomBreakdown	Constructs a CustomBreakdown object that specifies degree days broken down to match the DayRanges passed in.

Top

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)
	DayRanges	Gets the non-null DayRanges that specifies the dates that each degree-day figure should cover.

Top

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 CustomBreakdown with the same DayRanges 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.

Version History

Version	Description
1.2	This was added in version 1.2.

Reference

DegreeDays.Api.Data.Impl Namespace