Back to Aurora Vision Library website

You are here: Start » Function Reference » Data Flow » Loop Generators » EnumerateIntegers


Header: STD.h
Namespace: avl
Module: FoundationLite

In each consecutive iteration produces a consecutive number from an arithmetic sequence.


bool avl::EnumerateIntegers
	Enumerate1DState& ioState,
	int inStart,
	atl::Optional<int> inCount,
	int inStep,
	bool inRepeat,
	int& outValue,
	atl::Optional<bool> outIsFirst = atl::NIL,
	atl::Optional<bool> outIsLast = atl::NIL


Name Type Range Default Description
Input will be modified
ioState Enumerate1DState& Object used to maintain state of the function.
Input value
inStart int First value of the generated sequence
Input value
inCount Optional<int> 0 - NIL Length of the generated sequence
Input value
inStep int Value added in each iteration
Input value
inRepeat bool Determines whether to repeat loop
Output value
outValue int&
Output value
outIsFirst Optional<bool> NIL Flag indicating the first iteration
Output value
outIsLast Optional<bool> NIL Flag indicating the last iteration

Optional Outputs

The computation of following outputs can be switched off by passing value atl::NIL to these parameters: outIsFirst, outIsLast.

Read more about Optional Outputs.