TimeSchedule
Class Description
Description of anything that changes through time. Time schedule is used to perform a single-valued function of time. Use inherited 'type' attribute to give additional information on this schedule, such as: periodic (hourly, daily, weekly, monthly, etc.), day of the month, by date, calendar (specific times and dates).
Attributes
| Name | Type | Description |
|---|---|---|
| disabled | Boolean | True if this schedule is deactivated (disabled). |
| offset | Seconds | The offset from midnight (i.e., 0 h, 0 min, 0 s) for the periodic time points to begin. For example, for an interval meter that is set up for five minute intervals ('recurrencePeriod'=300=5 min), setting 'offset'=120=2 min would result in scheduled events to read the meter executing at 2 min, 7 min, 12 min, 17 min, 22 min, 27 min, 32 min, 37 min, 42 min, 47 min, 52 min, and 57 min past each hour. |
| recurrencePattern | String | Interval at which the scheduled action repeats (e.g., first Monday of every month, last day of the month, etc.). |
| recurrencePeriod | Seconds | Duration between time points, from the beginning of one period to the beginning of the next period. Note that a device like a meter may have multiple interval periods (e.g., 1 min, 5 min, 15 min, 30 min, or 60 min). |
| scheduleInterval | DateTimeInterval | Schedule date and time interval. |
Relationships
Ancestors
Descendents
Associations
| Source Class | Source Cardinality | Target | Target Cardinality | Source Name | Source Assoc. Description | Target Name | Target Assoc. Description |
|---|---|---|---|---|---|---|---|
| TimeSchedule | 1 | TimePoint | 0..* | TimeSchedule | Time schedule owning this time point. | TimePoints | Sequence of time points belonging to this time schedule. |