BuildingOperatingYearSchedule.Create
Method
Description:
Creates a valid BuildingOperatingYearSchedule with the given name, where every day has the schedule daySchedule.
Creates a valid BuildingOperatingYearSchedule with the given name, where every day has the schedule daySchedule.
Syntax
public static BuildingOperatingYearSchedule Create(
Document document,
BuildingOperatingDaySchedule daySchedule,
string name
)
Parameters
Parameter | Type | Description |
---|---|---|
document | Document | The document to create this BuildingOperatingYearSchedule for. |
daySchedule | BuildingOperatingDaySchedule | A schedule to assign to every day. |
name | String | The intended schedule name, may be modified to disambiguate with existing elements. |
Return Value
Type | Description |
---|---|
BuildingOperatingYearSchedule | The newly created BuildingOperatingYearSchedule. |
Exceptions
Exception | Condition |
---|---|
ArgumentException | daySchedule must be in the same document. -or- name cannot include prohibited characters, such as "{, }, [, ], |, ;, less-than sign, greater-than sign, ?, `, ~". -or- name must be trimmed. -or- name is an empty string or contains only whitespace. |
ArgumentNullException | A non-optional argument was null |