Difference between revisions of "Component: Timed Event Trigger (Runtime Tools)"
From Flowcode Help
Jump to navigationJump to search| Line 16: | Line 16: | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 24: | Line 26: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 92: | Line 96: | ||
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] - | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL |
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
Revision as of 13:29, 17 November 2021
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Runtime Tools |
Contents
Timed Event Trigger component
Component that will check to see if a predetermined amount of time has passed. Useful for doing things on a regular basis, e.g. every minute or every hour.
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Downloadable macro reference
|
Reset |
| Resets the countdown timer | |
 - VOID
|
Return |
|
|
SetTimePeriod |
| Sets the time period in seconds. Ideally this should only be called when the timer is not running. Automatically stops, resets and restarts the timer if already running. | |
 - ULONG
|
Time |
| Time period in units specified | |
 - BYTE
|
Units |
| 0=Seconds, 1=Minutes, 2=Hours | |
| - VOID
|
Return |
|
|
Stop |
| Stops the countdown timer running | |
| - VOID
|
Return |
|
|
CheckTrigger |
| Checks the state of the trigger to determine if the allocated amount of time has passed. Returns true if amount of time has passed, otherwise returns false. | |
 - BOOL
|
Return |
|
|
Start |
| Starts the countdown timer running. Automatically performs a reset if the event has already been triggered. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Time Period Units |
| Units of time to wait for | |
|
Time Period Value |
| Number of time periods to wait before firing | |
|
Call a macro |
| Decides if a user macro wil be called when the event time period is over. No - requires the use of polling in your application by calling the CheckTrigger component macro. Yes - Automatically calls the selected user macro | |
|
|
Auto Reset |
| Yes: Automatically resets and restarts the timer when running and actioned. No: Waits for the user to restart the timer running by calling the Start macro. | |
|
Connections |
|
|
Simulations |
