Back to FabImage Library website

You are here: Start » Function Reference » All Functions » Loop Utils » AccumulateElements

AccumulateElements


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: fil
Module: FoundationLite

Creates an array from elements appearing in many iterations.

Syntax

void fil::AccumulateElements
(
	const typename ftl::ToConditionalType<const T&>::Type& inElement,
	bool inCondition,
	ftl::Optional<int> inMaxSize,
	bool inReset,
	ftl::Array<Type>& outArray
)

Parameters

Name Type Range Default Description
Input value
 inElement const typename ToConditionalType<const T&>::Type& Element to be put into an array
Input value
 inCondition bool True Flag indicating whether to put the input element into an array or not
Input value
 inMaxSize Optional<int> 0 - NIL Maximum number of last elements that are remembered
Input value
 inReset bool False Reset accumulator state
Output value
 outArray Array<Type>& Array of accumulated elements

Hints

  • Instantiate this filter with a conditional type to create an array with conditional elements.

Errors

List of possible exceptions:

Error type Description
DomainError inMaxSize cannot be negative in AccumulateElements.