Difference between revisions of "Component: Timed Event Trigger (Runtime Tools)"
From Flowcode Help
Jump to navigationJump to search| Line 15: | Line 15: | ||
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. | 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. | ||
| − | ==Component | + | ==Component Source Code== |
| − | + | Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_EventTrigger.fcfx FC_Comp_Source_EventTrigger.fcfx] | |
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 32: | Line 34: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 151: | Line 155: | ||
|- | |- | ||
| colspan="2" | 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. | | colspan="2" | 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. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|} | |} | ||
Revision as of 17:46, 9 November 2022
| 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.
Component Source Code
Please click here for the component source code: FC_Comp_Source_EventTrigger.fcfx
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. | |
