Cumulative

Syntax

Cumulative(Input: ITimeSeries,
           Method: MsCumulativeMethodType,
           Period: IMsPeriod,
           IgnoreMissing: Boolean,
           Frequency: MsFrequency,
           Offset: Integer)

Parameters

Input. Output variable.

Method. Cumulative method. Optional parameter. By default the parameter is set to MsCumulativeMethodType.Sum - the sum of values of range elements is determined.

Period. Period, at which the method is calculated. Optional parameter. If the parameter value is Null, the method is calculated at the entire time period.

IgnoreMissing. It indicates that empty values are ignored. Optional parameter. The parameter is set to False by default.

Frequency. Calendar frequency in which method is calculated. Optional parameter. The parameter is set to MsFrequency.Undefined by default.

Offset. Offset of the series last point, to which accumulation is calculated. Optional parameter. The parameter is equal to 0 by default.

Description

It transforms the variable using the specified cumulative method.

Comments

Available values of the IgnoreMissing parameter:

True. Calculation does not take into account empty values.
False. Calculation takes into account empty values.

If the Frequency parameter is set to:

MsFrequency.Undefined. Accumulation starts at the series beginning.
MsFrequency.Annual. The Cumulative method behavior is the same as behavior of the CumulativeYTD function.

In order that calculation will be correct, the frequency specified in the Frequency parameter should be greater that modeling variable frequency.

The Offset parameter value is set in modeling variable frequency.

Example

Formula	Result	Application
= Cumulative({Brazil\|BCA[t]}, MsCumulativeMethodType.Average, SetPeriod("01.01.2000","01.01.2015"))	For the Brazil\|BCA factor the accumulated average is calculated for the period from 2000 to 2015.	It can be used in formulas of calculated series of time series database and in formulas of attribute-based models of modeling container.
= Cumulative(X1,MsCumulativeMethodType.Sum)	For the X1 factor the accumulated sum is calculated for the whole time period.	It can be used in model variable-based formulas of modeling container.