Difference between revisions of "Scheduler"
| Line 1: | Line 1: | ||
{{UI Object Header}}[[Category:INCOMPLETE]] | {{UI Object Header}}[[Category:INCOMPLETE]] | ||
| + | This object provides the user interface to the HSYCO's scheduler system. | ||
| + | The scheduler is a powerful function that allows you to define a set of calendar entries to schedule actions at the beginning and end of each time interval. | ||
| − | |||
| − | |||
A normal scheduler rule is defined with a start date/time and an end date/time and is valid within the defined period, even across several days. A daily rule is instead defined to be valid between a start time and end time, on a single day or spanning several days. | A normal scheduler rule is defined with a start date/time and an end date/time and is valid within the defined period, even across several days. A daily rule is instead defined to be valid between a start time and end time, on a single day or spanning several days. | ||
In addition to the validity dates, you can set a rule to be active only on specific week days. | In addition to the validity dates, you can set a rule to be active only on specific week days. | ||
When the current time matches the date/time and week days, the default behavior is that the scheduler generates a TIMER <schedule name> = ON event and the corresponding userTimerEvent() Java callback — just like the (timer) object — and a TIMER <schedule name> = OFF event at the end of the period. | When the current time matches the date/time and week days, the default behavior is that the scheduler generates a TIMER <schedule name> = ON event and the corresponding userTimerEvent() Java callback — just like the (timer) object — and a TIMER <schedule name> = OFF event at the end of the period. | ||
| + | |||
You can also define an interval rule, setting the on and off minutes. An interval rule will go on and off repeatedly during the date/time validity period. | You can also define an interval rule, setting the on and off minutes. An interval rule will go on and off repeatedly during the date/time validity period. | ||
Each rule has a name. This name is used to generate the events, and is not unique, as you can define several rules under the same name. In this case the scheduler will evaluate the rules having the same name in the order they appear in the scheduler display, from top to bottom. When a rule matches the date/time validity period, the scheduler stops checking any following rules with the same name. So, rules on top have priority within the group of rules with the same name. | Each rule has a name. This name is used to generate the events, and is not unique, as you can define several rules under the same name. In this case the scheduler will evaluate the rules having the same name in the order they appear in the scheduler display, from top to bottom. When a rule matches the date/time validity period, the scheduler stops checking any following rules with the same name. So, rules on top have priority within the group of rules with the same name. | ||
Rules set to work in off mode are used as “blocking rules”, because when they are valid they will not become active, and at the same time will prevent the scheduler from processing the following rules that could otherwise match. | Rules set to work in off mode are used as “blocking rules”, because when they are valid they will not become active, and at the same time will prevent the scheduler from processing the following rules that could otherwise match. | ||
| − | (scheduler <pos>; <width>; <height>; <mode>; <names>) | + | == Parameters == |
| + | *'''id''': the object's ID, used by UISets | ||
| + | *'''position''': the object's position. Use the pixels or rows and columns coordinates format | ||
| + | *'''size''': panel's width, in pixels | ||
| + | *'''rule list mode''': set to “edit” to enable the creation or deletion of individual schedules. Set to “noedit” to only allow editing of already defined schedules | ||
| + | *'''groups''': optional, comma separated list of schedule group names that are shown in this object. If the list is not defined or set to "*", the object shows all groups | ||
| + | |||
| + | == Syntax == | ||
| + | (scheduler <pos>; <width>; <height>; <mode>; <names>) | ||
| − | + | == UI Attributes == | |
| − | + | {{UI Object Attributes (Common)}} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 18:16, 29 January 2014
For a description and a complete list of UI Objects, see This object provides the user interface to the HSYCO's scheduler system. The scheduler is a powerful function that allows you to define a set of calendar entries to schedule actions at the beginning and end of each time interval.
A normal scheduler rule is defined with a start date/time and an end date/time and is valid within the defined period, even across several days. A daily rule is instead defined to be valid between a start time and end time, on a single day or spanning several days.
In addition to the validity dates, you can set a rule to be active only on specific week days.
When the current time matches the date/time and week days, the default behavior is that the scheduler generates a TIMER <schedule name> = ON event and the corresponding userTimerEvent() Java callback — just like the (timer) object — and a TIMER <schedule name> = OFF event at the end of the period.
You can also define an interval rule, setting the on and off minutes. An interval rule will go on and off repeatedly during the date/time validity period. Each rule has a name. This name is used to generate the events, and is not unique, as you can define several rules under the same name. In this case the scheduler will evaluate the rules having the same name in the order they appear in the scheduler display, from top to bottom. When a rule matches the date/time validity period, the scheduler stops checking any following rules with the same name. So, rules on top have priority within the group of rules with the same name. Rules set to work in off mode are used as “blocking rules”, because when they are valid they will not become active, and at the same time will prevent the scheduler from processing the following rules that could otherwise match.
Parameters
- id: the object's ID, used by UISets
- position: the object's position. Use the pixels or rows and columns coordinates format
- size: panel's width, in pixels
- rule list mode: set to “edit” to enable the creation or deletion of individual schedules. Set to “noedit” to only allow editing of already defined schedules
- groups: optional, comma separated list of schedule group names that are shown in this object. If the list is not defined or set to "*", the object shows all groups
Syntax
(scheduler <pos>; <width>; <height>; <mode>; <names>)
UI Attributes
Common attributes
| Name | Value | Description |
|---|---|---|
| pos | x<x>y<y> | Position specified as x/y coordinates. E.g. x-5y10 |
| r<r>c<c> | Position specified as row/column. E.g. r1c2 | |
| visible | true | Default. Show the object |
| false | Hide the object | |
| blink | true | slow | Blink the object at a slow speed |
| fast | Blink the object at a fast speed | |
| false | Stop the blinking | |
| opacity | 0.0 ... 1.0 | Object opacity from 0 (not visible) to 1 (fully visible) |
| rotation | 0 ... 360 | Object rotation in degrees. Images are rotated around the center point, all other objects are rotated around the top left corner |
