Difference between revisions of "Component: Timed Event Trigger (Runtime Tools)"
From Flowcode Help
Jump to navigationJump to search| (4 intermediate revisions by one other user not shown) | |||
| Line 49: | Line 49: | ||
==Examples== | ==Examples== | ||
| + | A basic xy chart logging example using the Timed Event Trigger to call a user macro every second, | ||
| + | {{Fcfile|Logging_Example.fcsx|Timed Event Trigger}} | ||
| + | ==Macro reference== | ||
| + | ===CheckTrigger=== | ||
| + | {| 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'' | ||
| + | |} | ||
| − | + | ===Reset=== | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | == | ||
| − | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 92: | Line 83: | ||
| + | ===SetTimePeriod=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 115: | Line 107: | ||
| + | ===Start=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Start''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Starts the countdown timer running. Automatically performs a reset if the event has already been triggered. |
|- | |- | ||
|- | |- | ||
| Line 128: | Line 121: | ||
| + | ===Stop=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Stop''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Stops the countdown timer running |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
|- | |- | ||
| Line 152: | Line 133: | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| − | |||
| − | |||
Latest revision as of 09:57, 11 April 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
A basic xy chart logging example using the Timed Event Trigger to call a user macro every second,
Macro reference
CheckTrigger
|
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 |
Reset
|
|
Reset |
| Resets the countdown timer | |
 - VOID
|
Return |
SetTimePeriod
|
|
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 |
Start
|
|
Start |
| Starts the countdown timer running. Automatically performs a reset if the event has already been triggered. | |
| - VOID
|
Return |
Stop
|
|
Stop |
| Stops the countdown timer running | |
| - 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. | |
