Jump to content

Component: Timed Event Trigger (Runtime Tools): Difference between revisions

From Flowcode Help
← Older edit

SteveT (talk | contribs)

4 user groups
6,393 edits
No edit summary
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(9 intermediate revisions by 3 users not shown)
Line 22: Line 22:


==Detailed description==
==Detailed description==




Line 47: 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}}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
''<span style="color:red;">No additional examples</span>''
 


==Macro reference==
==Macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===CheckTrigger===
|-
{| class="mtx-class-macrotable wikitable"
| 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&nbsp;
|-
|-
| 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.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Time
|-
| colspan="2" | Time period in units specified&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Units
|-
| colspan="2" | 0=Seconds, 1=Minutes, 2=Hours&nbsp;
|-
| 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&nbsp;
|-
|-
| 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.&nbsp;
|-
|-
| 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.&nbsp;
|-
|-
| 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&nbsp;
|-
| 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&nbsp;
|-
| 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&nbsp;
|-
| 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.&nbsp;
|}==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&nbsp;
|-
|-
| 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.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Time
|-
| colspan="2" | Time period in units specified&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Units
|-
| colspan="2" | 0=Seconds, 1=Minutes, 2=Hours&nbsp;
|-
| 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&nbsp;
|-
|-
| 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="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CheckTrigger'''
| 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.&nbsp;
| 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.&nbsp;
Line 241: Line 69:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===Reset===
|-
{| class="mtx-class-macrotable wikitable"
| 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.&nbsp;
|-
|-
| 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&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" | Time Period Value
| width="90%" class="mtx-class-macrohead" | '''Reset'''
|-
| colspan="2" | Number of time periods to wait before firing&nbsp;
|-
| 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&nbsp;
|-
| 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.&nbsp;
|}==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&nbsp;
| colspan="2" | Resets the countdown timer&nbsp;
Line 298: Line 83:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetTimePeriod===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetTimePeriod'''
| 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.&nbsp;
| 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.&nbsp;
Line 321: Line 107:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===Start===
|-
{| class="mtx-class-macrotable wikitable"
| 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&nbsp;
|-
|-
| 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="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CheckTrigger'''
| width="90%" class="mtx-class-macrohead" | '''Start'''
|-
| 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.&nbsp;
|-
|-
| 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.&nbsp;
| colspan="2" | Starts the countdown timer running. Automatically performs a reset if the event has already been triggered.&nbsp;
Line 360: Line 121:




 
===Stop===
 
{| class="mtx-class-macrotable wikitable"
==Property reference==
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
| width="90%" class="mtx-class-macrohead" | '''Stop'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Time Period Units
|-
| colspan="2" | Units of time to wait for&nbsp;
|-
| 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&nbsp;
|-
| 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&nbsp;
|-
| 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.&nbsp;
|}==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&nbsp;
|-
|-
| 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.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Time
|-
| colspan="2" | Time period in units specified&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Units
|-
| colspan="2" | 0=Seconds, 1=Minutes, 2=Hours&nbsp;
|-
| 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&nbsp;
| colspan="2" | Stops the countdown timer running&nbsp;
Line 438: Line 133:
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| 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.&nbsp;
|-
|-
| 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.&nbsp;
|-
|-
| 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==
==Property reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
| 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,

Timed Event Trigger

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. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Timed_Event_Trigger_(Runtime_Tools)&oldid=46763"