API description
Helper Loop Periodic Timing
Init Helper Loop Info
Get an object instance containing the Helper Loop Timing info.
| The object is set to not execute the Timeout case (i. e Timeout = -1). |
You can define how the late execution is handled by choosing one of the three following method:
- Process missed periods ignoring original phase
-
This is the default behavior. This mode will not try to recover from a late execution. The drift will increase each time a late execution occurs.
- No change
-
This mode will try to make sure that the drift will remain equal to 0 even if some late execution occurs.
- Process missed periods maintaining original phase
-
This mode behaves like the metronome function. The drift will always be a multiple of the execution period.
Get Timeout
Get the value of the timeout.
Use this function to connect the event structure Timeout input.
If the Late? output is TRUE, this indicates that the Timeout case is not executed at the desired period.
|
Update Last Execution Time
Set the last time the Timeout case event was executed.
| This function must be wired to the Time event data node of the Timeout case |
Current Number Of Execution—property-node
Number of Timeout case execution since last use of the Set Helper Loop Period function.
| This counter si reset when period is modified and when the helper loop is stopped. |
Helper Loop Period—property-node
Number of Timeout case execution since last use of the Set Helper Loop Period function.
| This counter si reset when period is modified and when the helper loop is stopped. |
Basic Helper Loop With Periodic Timing
Drag this function in your diagram to place a ready-to-use Helper Loop With Periodic Timing.
