Table 10 – ScheduleType definition
|
Attribute |
Value |
||||
|
BrowseName |
ScheduleType |
||||
|
IsAbstract |
False |
||||
|
Description |
Defines a periodic schedule that can recur over a range of dates. The schedule may have optional exceptions at arbitrary times or dates. The basic unit of a schedule is days, which are divided into two types: normal days within a week and exception days. A priority mechanism defines which scheduled event is currently valid. The schedule includes a PresentValue Variable whose value describes the current state of the schedule, including a default value when no schedules are in effect. |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the 0:BaseObjectType |
|||||
|
0:HasProperty |
Variable |
ExceptionSchedule |
SpecialEventType[] |
0:PropertyType |
O |
|
0:HasComponent |
Method |
AddExceptionScheduleElements |
|
|
O |
|
0:HasComponent |
Method |
RemoveExceptionScheduleElements |
|
|
O |
|
0:HasProperty |
Variable |
WeeklySchedule |
DailyScheduleType[7] |
0:PropertyType |
O |
|
0:HasProperty |
Variable |
0:LocalTime |
0:TimeZoneDataType |
0:PropertyType |
M |
|
0: HasProperty |
Variable |
EffectivePeriod |
DateRangeType |
0:PropertyType |
O |
|
0:HasProperty |
Variable |
ApplyLastAfterStart |
0:Boolean |
0:PropertyType |
M |
|
Conformance Units |
|||||
|
Scheduler Scheduling Base |
|||||
The ExceptionSchedule provides an array of SpecialEventType. If present, each of those special events describes a sequence of schedule actions that take precedence over a normal day’s behaviour on a special day or days.
The WeeklySchedule provides an array of seven DailyScheduleType. Each entry represents one day of the week. The first entry in the array represents Monday, the last Sunday. Each element describes a sequence of times and a list of actions that provides a sequence of schedule actions on one day of the week when no ExceptionSchedule is in effect.
At least one of the two Properties ExceptionSchedule and WeeklySchedule shall be present.
To manipulate the ExceptionSchedule, the Methods AddExceptionScheduleElements and RemoveExceptionScheduleElements should be used. This simplifies adding and removing entries of the array. As the WeeklySchedule is a fixed-size array with a length of 7, there are no corresponding Methods. Instead, an individual entry of the array may be written by the Client to change only the schedule of one weekday.
The 0:LocalTime provides information about the local time of the schedule Object. All scheduled times are UTC time. Clients need to consider this Property to calculate the local time of the schedule. If this Property is changed, it is server-specific whether the times of the schedule are adjusted or not. If the Server and the Object the schedule is defined for are in the same local time, the Object may reference the 0:LocalTime Property of the 0:Server Object.
The EffectivePeriod specifies the range of dates within which the schedule Object is active. Upon entering its effective period, the object shall execute the defined actions at the defined times, otherwise it shall not execute any actions.
The ApplyLastAfterStart Property defines if the last set of actions shall be applied when starting the schedule Object (see 6.3 for details).
The child Nodes of the ScheduleType have additional Attribute values defined in Table 11.
Table 11 – ScheduleType Attribute values for child Nodes
|
BrowsePath |
Description Attribute |
|
ExceptionSchedule |
An array of special events. If present, each of those special events describes a sequence of schedule actions that take precedence over a normal day’s behaviour on a special day or days. |
|
AddExceptionScheduleElements |
Adds elements to the ExceptionSchedule |
|
RemoveExceptionScheduleElements |
Removes elements from the ExceptionSchedule |
|
WeeklySchedule |
Each entry represents one day of the week. The first entry in the array represents Monday, the last Sunday. Each element describes a sequence of times and a list of actions that provides a sequence of schedule actions on one day of the week when no ExceptionSchedule is in effect. |
|
0:LocalTime |
Provides information about the local time of the schedule Object. All scheduled times are UTC time. Clients need to consider this Property to calculate the local time of the schedule. If this Property is changed, it is server-specific whether the times of the schedule are adjusted or not. |
|
EffectivePeriod |
Specifies the range of dates within which the schedule Object is active. Upon entering its effective period, the object shall execute the defined actions at the defined times, otherwise it shall not execute any actions. |
|
ApplyLastAfterStart |
The ApplyLastAfterStart Property defines if the last set of actions shall be applied when starting the schedule Object |