CumulativeYTD

Syntax

CumulativeYTD(Input: ITimeSeries;
             Method: MsCumulativeMethodType,
             Period: IMsPeriod,
             IgnoreMissing: Boolean)

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.

Description

It transforms the variable using the specified cumulative method to the beginning of the year.

Comments

Available values of the IgnoreMissing parameter:

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

Example

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