Time Tables are used to schedule down-time, such as state changes, for specific objects in the model. Each Time Table may control many objects, and each object may be controlled by many Time Tables. A model may contain any number of Time Tables.
Time Tables are accessed from the Toolbox.
The main purpose of the Time Table object is to define scheduled periods of down-time for objects in the model. These down periods are defined by two numbers: a down time and a duration. The down period begins at the specified down time and will last for the specified duration in model time units. The functions on the Functions tab give you control over what happens to the objects listed in the Members tab at the beginning and end of each down period.
For convenience in working with down periods that wrap around the end of a day or week the Time Table will combine touching down periods that either set the same state and state profile or use the same down behavior. For example, in a weekly schedule, a down period that goes from Monday 10 PM to 12 AM will combine with a down period that goes from Tuesday 12 AM to 2 AM if the state / down behavior is the same.
When the Time Table hits a down time, two sets of functions are called. First, the Down Function is fired. This happens once for each member of the Time Table. This allows you to stop the associated object, send a TaskExecuter to some specified location, etc. After all of the Down Functions have fired, the On Down function will fire once. The On Down function passes in the list of members and the table row associated with the down time.
At the end of the down period's duration the set of resume functions are called. First, the Resume Function is fired. This happens once for each member of the Time Table. This allows you to resume the associated object, resume input on the object, etc. After all of the Resume Functions have fired, the On Resume function will fire once. The On Resume function passes in the list of members and the table row associated with the down time.
For each down time you can specify the state and state profile that the members will go to during that down period. These values are designed to be used with the stopobject() and resumeobject() commands found by default in the Down and Resume Functions. An object can be tied to multiple Time Tables and be stopped multiple times. Each object stores it's set of states each time it is stopped so the object can then be resumed and move back through the subsequent set of states.
Down periods can also optionally be associated with a down behavior. If a down behavior is specified, the down and resume functions will be called on the down behavior instead of on the time table itself. This allows you to define different kinds of down events that can be shared between different time tables and also allows down periods within the same time table to behave differently from each other. See Down Behaviors for more information.
The Time Table can be set up in different modes allowing for non-repeating/repeating schedules or schedules based upon date and time. The Daily Repeat, Weekly Repeat, and Date Based modes all utilize the Model Start Time and Date as defined in the Model Settings.
The following general settings are available:
The name of the Time Table. The combobox has a list of all Time Tables in the model, allowing you to quickly jump to different Time Tables.
Specifies whether the Time Table should execute it's down times for all of the members of the Time Table. The Experimenter allows you to enable and disable Time Tables for different scenarios.
Icon | Description |
---|---|
![]() |
Adds the Time Table to a User Library as either a Draggable Icon or an Auto-Install Component. |
The Members tab has the following properties:
Icon | Description |
---|---|
![]() |
This will open an object selection GUI where you can select multiple objects in the model. |
![]() |
Removes the selected member(s) from the list. |
![]() ![]() |
Reorders members Up or Down in the list. |
![]() |
Click to sample any object in the model to add it as a member. |
The Functions tab has the following properties:
This picklist is executed when the objects in the member list go down. It is executed once for each object in the member list. This is where you specify what to do to stop the object.
This picklist is executed when the objects in the member list resume their operation. It is executed once for each object in the member list. This is where you specify what to do to resume the object.
This picklist is fired immediately after the Down Function has been fired for all objects, but it is only executed once, instead of once for each object in the member list.
This picklist is fired immediately after the Resume Function has been fired for all objects, but it is only executed once, instead of once for each object in the member list.
The Table Tab has the following properties:
The Table Editor has the following properties:
The Graphical Table has the following properties:
Color.byNumber(labelValue)
or color(labelValue)
.Using the Graphical Table:
This event is fired once for each member when the table hits a down time.
It has the following parameters:
Event Parameter | Type | Explanation |
---|---|---|
Down Object | Object | The object going down |
State | int | The state the object will go into |
Table Row | int | The row corresponding to this down time in the table |
Duration | double | The duration of the down time |
State Profile | int | The state profile on the object that will be updated |
This event is fired once for each member when the table ends a down time.
It has the following parameters:
Event Parameter | Type | Explanation |
---|---|---|
Down Object | Object | The object that was down and is now resuming |
State | int | The state the object was in |
Table Row | int | The row corresponding to this down time in the table |
State Profile | int | The state profile on the object that will be updated |
This event is fired once after the Down Function has fired for all members.
It has the following parameters:
Event Parameter | Type | Explanation |
---|---|---|
Table Row | int | The row corresponding to this down time in the table |
This event is fired once after the Resume Function has fired for all members.
It has the following parameters:
Event Parameter | Type | Explanation |
---|---|---|
Table Row | int | The row corresponding to this down time in the table |