Rotimer – BrightSign Object Reference Manual (FW 5.1) User Manual
Page 317
309
roTimer
This object allows the script to trigger events at a specific date/time or during specified intervals. Events are triggered by
delivering roTimerEvent objects to the specified message port.
Interfaces:
The ifTimer interface provides the following:
•
SetTime(hour As Integer, minute As Integer, second As Integer, millisecond As Integer)
As Void: Sets the time for the event to trigger. In general, if a value is -1, then it is a wildcard and will cause the event
to trigger every time the rest of the specification matches. If there are no wildcards, then the timer will trigger only once
when the specified time occurs.
•
SetTime(a As Integer, b As Integer, c As Integer)
•
SetDate(year As Integer, month As Integer, day As Integer) As Void: Sets the date for the event
to trigger. In general, if a value is -1, then it is a wildcard and will cause the event to trigger every time the rest of the
specification matches. If there are no wildcards, then the timer will trigger only once when the specified date/time
occurs.
•
SetDayOfWeek(day_of_week As Integer) As Void: Sets the day of week for the event to trigger. In general, if
a value is -1, then it is a wildcard and will cause the event to trigger every time the rest of the specification matches. If
there are no wildcards, then the timer will trigger only once when the specified date/time occurs.
Note: It is possible, using a combination of day and day_of_week parameters, to specify invalid combinations that will
never occur. If specifications include any wildcard, then the second and millisecond specifications must be zero;
events will be raised at most once per minute near the whole minute.
•
SetDateTime(As ifDateTime) As Void: Sets the time when you wish the event to trigger from an roDateTime
object. It is not possible to set wildcards using this method.
•
Start() As Boolean: Starts the timer based on the current values specified using the above functions.
•
Stop(): Stops the timer.