Overview:Schedule dates.. A range of dates with an optional qualifier that specifies when a schedule is active.
This configuration property is used to create an array of schedule dates.
Each entry consists of a starting date, ending date, and date qualifier for
recurring events. Starting date and/or ending date may contain wildcards
(see below). The following table contains all possible combinations of wildcards
and their interpretation.
|
Start End
|
**-**-**
|
**-**-DE
|
**-ME-**
|
**-ME-DE
|
YE-**-**
|
YE-**-DE
|
YE-ME-**
|
YE-ME-DE
|
| **-**-** |
always |
each month from 1st to DEth day of month |
each year from 01-01 to last day of month ME |
each year from 01-01 to DEth day of month ME |
until YE-12-31 |
until YE-12-DE |
until YE-ME-31 |
until YE-ME-DE |
| **-**-DS |
each month from DSth day to last day of month |
each month from DSth to DEth day of month |
Invalid |
Invalid |
Invalid |
Invalid |
Invalid |
Invalid |
| **-MS-** |
each year from first day of month MS to 12-31 |
Invalid |
each year from 1st day of month MS to last day of month ME |
Invalid |
Invalid |
Invalid |
Invalid |
Invalid |
| **-MS-DS |
each year from DSth day of month MS to 12-31 |
Invalid |
Invalid |
each year from MS-DS to ME-DE |
Invalid |
Invalid |
Invalid |
Invalid |
| YS-**-** |
from YS-01-01 |
Invalid |
Invalid |
Invalid |
from YS-01-01 to YE-12-31 |
Invalid |
Invalid |
Invalid |
| YS-**-DS |
from YS-01-DS |
Invalid |
Invalid |
Invalid |
Invalid |
from YS-01-DS to YE-12-DE |
Invalid |
Invalid |
| YS-MS-** |
from YS-MS-01 |
Invalid |
Invalid |
Invalid |
Invalid |
Invalid |
from YS-MS-01 to YE-ME-31 |
Invalid |
| YS-MS-DS |
from YS-MS-DS |
Invalid |
Invalid |
Invalid |
Invalid |
Invalid |
Invalid |
YS-MS-DS to YE-ME-DE |
** ... wildcard (unspecified)
YS/YE ... Start/End Year
MS/ME ... Start/End Month
DS/DE ... Start/End Day
All other combinations are not specified and thus their behaviour is a local matter.
A possible behaviour would be to disable the schedule date entry, that is, treat it
as "never".
Details: | | Resource Set:
| Standard 00:00:00:00:00:00:00:00-0 | | Index:
| 273 | | Obsolete:
| no | | Size:
| 12 | | Programmatic Name:
| SCPTscheduleDates | | Default:
| -1 0 DM_EVERY_DAY -1 0 0 DM_EVERY_DAY MN_EVERY_MONTH DM_EVERY_DAY 65535 | |
Neuron C Type:
| |
Structure
| | start | Schedule start..
| | | |
Structure
| | year | Starting year.. Starting year for schedule.
Zero (0) means the starting year is not specified ("wildcard").
| | | | signed long | | Minimum:
| -1 | | Maximum:
| 3000 | | Invalid:
| -1 | |
Scaling (A,B,C):
| 1, 0, 0 | |
Scaled value:
| 1
*10 0
*(Raw+0)
| |
Resolution:
| 1 |
| | month | Starting month.. Starting month for schedule.
Zero (0) means the starting month is not specified ("wildcard").
| | | | unsigned short | | Minimum:
| 0 | | Maximum:
| 12 | |
Scaling (A,B,C):
| 1, 0, 0 | |
Scaled value:
| 1
*10 0
*(Raw+0)
| |
Resolution:
| 1 |
| | day | Starting day.. Starting day for schedule.
A value of DM_EVERY_DAY means the starting day is not specified ("wildcard").
If a value that corresponds to multiple days such as DM_EVERY_MON is specified for start.day,
the first day of the month that matches the value is used. In this case the start month must
not be unspecified ("a wildcard").
| | | |
| | end | Schedule end..
| | | |
Structure
| | year | Ending year.. Ending year for schedule.
Zero (0) means the starting ending year is not specified ("wildcard").
| | | | signed long | | Minimum:
| -1 | | Maximum:
| 3000 | | Invalid:
| -1 | |
Scaling (A,B,C):
| 1, 0, 0 | |
Scaled value:
| 1
*10 0
*(Raw+0)
| |
Resolution:
| 1 |
| | temporary | Temporary flag.. Identifies a temporary schedule. Temporary schedules are deleted at the end of the day that they are active.
| | | |
bitfield
| | Signed:
| no | | Width:
| 1 | | Offset:
| 0 | | Minimum:
| 0 | | Maximum:
| 1 | |
Scaling (A,B,C):
| 1, 0, 0 | |
Scaled value:
| 1
*10 0
*(Raw+0)
| |
Resolution:
| 1 |
| | month | Ending month.. Ending month for schedule.
Zero (0) means the ending month is not specified ("wildcard").
| | | |
bitfield
| | Signed:
| no | | Width:
| 7 | | Offset:
| 1 | | Minimum:
| 0 | | Maximum:
| 12 | |
Scaling (A,B,C):
| 1, 0, 0 | |
Scaled value:
| 1
*10 0
*(Raw+0)
| |
Resolution:
| 1 |
| | day | Ending day.. Ending day for schedule.
A value of DM_EVERY_DAY means the ending day is not specified ("wildcard").
If a value that corresponds to multiple days such as DM_EVERY_MON is specified for end.day,
the last day of the month that matches the value is used. In this case the end month must
not be unspecified ("a wildcard").
| | | |
| | qualifier | .
| | | |
Structure
| | months | Month qualifier.. Months within the dates specified by the start and end dates.
| | | | | days | Days qualifier.. Days within the dates specified by the start and end dates.
| | | |
| | schedule_index | Schedule number.. Index into a schedule or schedule name array.
| | | | unsigned long | | Minimum:
| 0 | | Maximum:
| 65535 | | Invalid:
| 65535 | |
Scaling (A,B,C):
| 1, 0, 0 | |
Scaled value:
| 1
*10 0
*(Raw+0)
| |
Resolution:
| 1 |
|
| |
Formats:
| SCPTscheduleDates:
text("%d %d %m %d %d %d %m %m %m %d", start.year, start.month, start.day, end.year, end.temporary, end.month, end.day, qualifier.months, qualifier.days, schedule_index)
| |
Used by:
| SFPTcalendar |
|
