Component: Timed Event Trigger (Runtime Tools): Difference between revisions
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead"" |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 56: | Line 56: | ||
===CheckTrigger=== | ===CheckTrigger=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 70: | Line 70: | ||
===Reset=== | ===Reset=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Reset''' | ||
|- | |- | ||
| colspan="2" | Resets the countdown timer | | colspan="2" | Resets the countdown timer | ||
| Line 84: | Line 84: | ||
===SetTimePeriod=== | ===SetTimePeriod=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''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. | | 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. | ||
| Line 108: | Line 108: | ||
===Start=== | ===Start=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Start''' | ||
|- | |- | ||
| colspan="2" | Starts the countdown timer running. Automatically performs a reset if the event has already been triggered. | | colspan="2" | Starts the countdown timer running. Automatically performs a reset if the event has already been triggered. | ||
| Line 122: | Line 122: | ||
===Stop=== | ===Stop=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Stop''' | ||
|- | |- | ||
| colspan="2" | Stops the countdown timer running | | colspan="2" | Stops the countdown timer running | ||
| Line 137: | Line 137: | ||
==Property reference== | ==Property reference== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Properties''' | ||
|- | |- | ||
|- | |- | ||
Latest revision as of 14:23, 13 July 2026
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Runtime Tools |
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. | |