DatedBreakdownWeekly Method

Returns a non-null WeeklyBreakdown object that specifies weekly degree days covering the specified period in time, with each "week" starting on the specified day of the week.

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

Syntax

Copy

public static WeeklyBreakdown Weekly(
	Period period,
	DayOfWeek firstDayOfWeek
)

Public Shared Function Weekly ( 
	period As Period,
	firstDayOfWeek As DayOfWeek
) As WeeklyBreakdown

Parameters

period Period: The period in time that the weekly breakdown should cover. Cannot be null.
firstDayOfWeek DayOfWeek: Indicates which day should be taken as the first of each week.

Return Value

WeeklyBreakdown
The newly-constructed WeeklyBreakdown object.

Exceptions

Exception	Condition
ArgumentNullException	period is null.
ArgumentOutOfRangeException	firstDayOfWeek is not a valid DayOfWeek value.

Remarks

To avoid the potential for confusion, you must explicitly specify the day of the week that you want each "week" to start on. For example, if a "week" should run from Monday to Sunday (inclusive), specify the firstDayOfWeek parameter as DayOfWeek.Monday.

Reference

DatedBreakdown Class

DegreeDays.Api.Data Namespace