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

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.

@@ Line 17: / Line 17: @@
 ==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]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/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==
@@ Line 31: / Line 33: @@
-''No detailed description exists yet for this component''
-==Examples==
@@ Line 45: / Line 45: @@
+''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,
+{{Fcfile|Logging_Example.fcsx|Timed Event Trigger}}
-''<span style="color:red;">No additional examples</span>''
+==Macro reference==
+===CheckTrigger===
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| 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;
+|-
+|-
+| 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''
+|}
-==Downloadable macro reference==
-{| 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="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Reset'''
+| width="90%" class="mtx-class-macrohead" | '''Reset'''
 |-
 | colspan="2" | Resets the countdown timer&nbsp;
@@ Line 64: / 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;
@@ Line 87: / 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="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Stop'''
+| width="90%" class="mtx-class-macrohead" | '''Start'''
 |-
-| colspan="2" | Stops the countdown timer running&nbsp;
+| colspan="2" | Starts the countdown timer running. Automatically performs a reset if the event has already been triggered.&nbsp;
 |-
 |-
@@ Line 100: / Line 121: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===Stop===
+{| 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;" | '''CheckTrigger'''
+| width="90%" class="mtx-class-macrohead" | '''Stop'''
 |-
-| 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" | Stops the countdown timer running&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;
 |-
 |-
@@ Line 124: / Line 133: @@
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
 ==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'''
 |-
 |-

SteveT (talk | contribs)