IModelling.Cumulative

Syntax

Cumulative(Input: ITimeSeries;

[Method: MsCumulativeMethodType = 5;]

[Period: IMsPeriod = Null;]

[IgnoreMissing: Boolean = False;]

[Frequency: MsFrequency = 0;]

[Offset: Integer = 0;]): Variant;

Parameters

Input. Output variable

Method. Cumulative method.

Period. Period, at which the method is calculated

IgnoreMissing. Indicates whether empty values are ignored.

Frequency. Calendar frequency, in which method is calculated.

Offset. Offset of the last series point, to which accumulation is calculated.

Description

The Cumulative method transforms variable using selected cumulative method.

Comments

Features of setting parameters:

Period. If the parameter is set to Null, the method is calculated at the entire time period
IgnoreMissing. Available values of the parameter:

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

Frequency. If the 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 IModelling.CumulativeYTD method.

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

Offset. The parameter value is set in output variable frequency.

Example

Executing the example requires that the repository contains a modeling container with the MS identifier. This container includes a model with the MODEL_D identifier that is calculated by the determinate equation method and contains at least one factor.

Add links to the Metabase and Ms system assemblies.

Sub UserProc;
Var
    Mb: IMetabase;
    ModelSpace, ModelObj: IMetabaseObject;
    Transf: IMsFormulaTransform;
    Formula: IMsFormula;
    Model: IMsModel;
    Determ: IMsDeterministicTransform;
    TransVar: IMsFormulaTransformVariable;
    Slice: IMsFormulaTransformSlice;
    TermInfo: IMsFormulaTermInfo;
    Expr: IExpression;
Begin
    // Get repository
    Mb := MetabaseClass.Active;
    // Get modeling container
    ModelSpace := Mb.ItemById("MS").Bind;
    // Get the model
    ModelObj := Mb.ItemByIdNamespace("MODEL_D", ModelSpace.Key).Edit;
    Model := ModelObj As IMsModel;
    // Get model calculation parameters
    Transf := Model.Transform;
    Formula := Transf.FormulaItem(0);
    Determ := Formula.Method As IMsDeterministicTransform;
    // Get the first input variable
    TransVar := Transf.Inputs.Item(0);
    Slice := TransVar.Slices.Item(0);
    TermInfo := Transf.CreateTermInfo;
    TermInfo.Slice := Slice;
    // Set mode of passing variable into calculation
    TermInfo.Type := MsFormulaTermType.Pointwise;
    // Get model calculation expression
    Expr := Determ.Expression;
    Expr.References := "Ms";
    // Set model calculation expression
    Expr.AsString := "Cumulative(" + TermInfo.TermInnerText + ", MsCumulativeMethodType.Max, SetPeriod(" +
        """" + "01.01.2000" + """" + "," + """" + "01.01.2015" + """" +
        "), True)";
    // Check if the expression is correct
    If Expr.Valid
        // If the expression is set correctly, save the model
        Then ModelObj.Save;
        // If the expression is incorrect, display a message to the console window
        Else Debug.WriteLine("Model is not saved: error in the formula");
    End If;
End Sub UserProc;

After executing the example the model transforms a variable by applying the Maximum cumulative method without taking into account skipped values for the period from 2000 to 2015.

Example of Use in Expressions

Expression 1:

Cumulative({Brazil|BCA[t]},MsCumulativeMethodType.Average, SetPeriod("01.01.2000", "01.01.2015"))

Result: for the Brazil|BCA factor the accumulated average is calculated for the period from 2000 to 2015.

Use: it can be used in formulas of cross functional expression editor in any platform tool where it is available.

Expression 2:

Cumulative(X1,MsCumulativeMethodType.Sum)

Result: for the X1 factor the accumulated sum is calculated at the entire time period.

Use: it can be used in model formulas of modeling container based on variables.