You are here: Start » Function Reference » Profile Combinators » AccumulateProfile

AccumulateProfile

Header:	FIL.h
Namespace:	fil

Returns a profile of most recent values.

Syntax

void fil::AccumulateProfile
(
	AccumulateProfileState& ioState,
	const float inValue,
	ftl::Optional<int> inMaxCount,
	bool inReset,
	fil::Profile& outProfile
)

Parameters

Name	Type	Range	Default	Description
ioState	AccumulateProfileState&			Object used to maintain state of the function.
inValue	const float
inMaxCount	Optional<int>	0 -	NIL	Number of last values that are remembered
inReset	bool			Reset accumulator state
outProfile	Profile&			Output profile

Errors

List of possible exceptions:

Error type	Description
DomainError	inMaxCount cannot be negative in AccumulateProfile.