Difference between revisions of "Component: Timed Event Trigger (Runtime Tools)"
From Flowcode Help
Jump to navigationJump to search| Line 16: | Line 16: | ||
==Component Source Code== | ==Component Source Code== | ||
| + | |||
| + | Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_EventTrigger.fcfx FC_Comp_Source_EventTrigger.fcfx] | ||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EventTrigger.fcfx FC_Comp_Source_EventTrigger.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EventTrigger.fcfx FC_Comp_Source_EventTrigger.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 40: | Line 44: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 62: | Line 68: | ||
==Macro reference== | ==Macro reference== | ||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Reset''' | ||
| + | |- | ||
| + | | colspan="2" | Resets the countdown timer | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetTimePeriod''' | ||
| + | |- | ||
| + | | colspan="2" | 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. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG | ||
| + | | width="90%" | Time | ||
| + | |- | ||
| + | | colspan="2" | Time period in units specified | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Units | ||
| + | |- | ||
| + | | colspan="2" | 0=Seconds, 1=Minutes, 2=Hours | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Stop''' | ||
| + | |- | ||
| + | | colspan="2" | Stops the countdown timer running | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CheckTrigger''' | ||
| + | |- | ||
| + | | colspan="2" | 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. | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Start''' | ||
| + | |- | ||
| + | | colspan="2" | Starts the countdown timer running. Automatically performs a reset if the event has already been triggered. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Property reference== | ||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Time Period Units | ||
| + | |- | ||
| + | | colspan="2" | Units of time to wait for | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | Time Period Value | ||
| + | |- | ||
| + | | colspan="2" | Number of time periods to wait before firing | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| + | | width="90%" | Call a macro | ||
| + | |- | ||
| + | | colspan="2" | 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 | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| + | | width="90%" | Auto Reset | ||
| + | |- | ||
| + | | 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. | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 15:21, 20 January 2023
| 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 to download the component source project: FC_Comp_Source_EventTrigger.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_EventTrigger.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
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. | |
==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. | |
==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. | |
