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

SystemObject
  DegreeDays.Api.DataBreakdown
    DegreeDays.Api.DataDatedBreakdown
      DegreeDays.Api.Data.ImplWeeklyBreakdown

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

Syntax

Copy

public sealed class WeeklyBreakdown : DatedBreakdown

Public NotInheritable Class WeeklyBreakdown
	Inherits DatedBreakdown

The WeeklyBreakdown type exposes the following members.

Constructors

	Name	Description
	WeeklyBreakdown	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

	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)
	FirstDayOfWeek	Gets the day of the week that should be the first of each weekly period.
	Period	Gets the non-null period in time that the weekly breakdown 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 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.

Reference

DegreeDays.Api.Data.Impl Namespace