: Public Class
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).<br/><br/>
- Attributes
- Associations To
- Other Links
Attribute |
Public Boolean disabled
|
Details:
Alias: |
|
Initial: |
|
Stereotype: |
|
Ordered: |
|
Range: |
Range:0 to 1 |
Transient: |
False |
Derived: |
False |
IsID: |
False |
Notes:
|
True if this schedule is deactivated (disabled).<br/>
|
|
Public Seconds offset
|
Details:
Alias: |
|
Initial: |
|
Stereotype: |
|
Ordered: |
|
Range: |
Range:0 to 1 |
Transient: |
False |
Derived: |
False |
IsID: |
False |
Notes:
|
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.<br/>
|
|
Public String recurrencePattern
|
Details:
Alias: |
|
Initial: |
|
Stereotype: |
|
Ordered: |
|
Range: |
Range:0 to 1 |
Transient: |
False |
Derived: |
False |
IsID: |
False |
Notes:
|
Interval at which the scheduled action repeats (e.g., first Monday of every month, last day of the month, etc.).<br/>
|
|
Public Seconds recurrencePeriod
|
Details:
Alias: |
|
Initial: |
|
Stereotype: |
|
Ordered: |
|
Range: |
Range:0 to 1 |
Transient: |
False |
Derived: |
False |
IsID: |
False |
Notes:
|
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).<br/>
|
|
Public DateTimeInterval scheduleInterval
|
Details:
Alias: |
|
Initial: |
|
Stereotype: |
|
Ordered: |
|
Range: |
Range:0 to 1 |
Transient: |
False |
Derived: |
False |
IsID: |
False |
Notes:
|
Schedule date and time interval.<br/>
|
|
Element |
Source Role |
Target Role |
TimePoint
Class
|
Name: TimeSchedule
Time schedule owning this time point.
|
Name: TimePoints
Sequence of time points belonging to this time schedule.
|
 Details:
|