IModelling.PchY

Syntax

PchY(Input: ITimeSeries): Variant;

Parameters

Input. Variable.

Description

The PchY method calculates the rate of change of variable points in comparison with the corresponding period of the previous year.

Comments

The rate of change of variable points is calculated by the formula: (X[t]/X[t-N*F]-1)*100, where F - corresponding period of the previous year.

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 input variable.

Add links to the Metabase and Ms system assemblies.

Sub UserNvl;
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 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 := "PchY(" + TermInfo.TermInnerText + ")";
    // 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 UserNvl;

After executing the example the model will calculate rate of change of the first input variable points to the corresponding period of the previous year.

Example of Use in Expressions

Expression 1:

PchY({Brazil|BCA})

Result: the rate of change of Brazil|BCA factor observations is calculated to the corresponding period of the previous year.

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

Expression 2:

PchY(X1)

Result: the rate of change of X1 factor points is calculated to the corresponding period of the previous year.

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