Back to Aurora Vision Library website

You are here: Start » Function Reference » All Functions » Loop Generators » Repeat

Repeat


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header: STD.h
Namespace: avl
Module: FoundationLite

Generates a loop that ends at the first invocation with True on the input.

Applications: Put this filter into a task that should have a loop, but does not have any other loop generators (e.g. GrabImage).

Syntax

bool avl::Repeat
(
	DelayByPeriodState& ioState,
	bool inUntil,
	int inDelay = 0
)

Parameters

Name Type Default Description
Input will be modified ioState DelayByPeriodState& Object used to maintain state of the function.
Input value inUntil bool False If 'True' the loop will break
Input value inDelay int 0 Time between iterations in milliseconds

Remarks

The Delay parameter determines how long the Repeat filter will last in subsequent iterations. The value is not taken into consideration in the first iteration. Therefore, the Repeat filter should be put at the beginning of the macrofilter if the user needs to set the delay between iterations.