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

From Flowcode Help
Jump to navigationJump to search
Line 17: Line 17:
 
==Component Source Code==
 
==Component Source Code==
  
−
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 download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/EventTrigger.fcfx FC_Comp_Source_temp/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_temp/EventTrigger.fcfx FC_Comp_Source_temp/EventTrigger.fcfx]
  
 
==Detailed description==
 
==Detailed description==
Line 73: Line 73:
  
 
''<span style="color:red;">No additional examples</span>''
 
''<span style="color:red;">No additional examples</span>''
 +
 +
  
  
Line 80: Line 82:
  
 
==Macro reference==
 
==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.&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''
 +
|}
 +
  
 
===Reset===
 
===Reset===
Line 119: Line 135:
  
  
−
===Stop===
+
===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;" | '''Stop'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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 133: Line 149:
  
  
−
===CheckTrigger===
+
===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;" | '''CheckTrigger'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
 
−
|}
 
−
 
 
−
 
 
−
===Start===
 
−
{| 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;
 
 
|-
 
|-
 
|-
 
|-

Revision as of 12:00, 3 February 2023

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_temp/EventTrigger.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/EventTrigger.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples





Macro reference

CheckTrigger

Fc9-comp-macro.png 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. 
Fc9-bool-icon.png - BOOL Return


Reset

Fc9-comp-macro.png Reset
Resets the countdown timer 
Fc9-void-icon.png - VOID Return


SetTimePeriod

Fc9-comp-macro.png 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. 
Fc9-u32-icon.png - ULONG Time
Time period in units specified 
Fc9-u8-icon.png - BYTE Units
0=Seconds, 1=Minutes, 2=Hours 
Fc9-void-icon.png - VOID Return


Start

Fc9-comp-macro.png Start
Starts the countdown timer running. Automatically performs a reset if the event has already been triggered. 
Fc9-void-icon.png - VOID Return


Stop

Fc9-comp-macro.png Stop
Stops the countdown timer running 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Time Period Units
Units of time to wait for 
Fc9-type-21-icon.png Time Period Value
Number of time periods to wait before firing 
Fc9-type-7-icon.png 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 
Fc9-type-7-icon.png 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=36470"