IModelling.PchY

Syntax

PchY(Input: ITimeSeries): Variant;

Parameters

Input - variable.

Description

The PchY method calculates the rate of change of variable points to the corresponding period (F) of the previous year: (X[t]/X[t-N*F]-1)*100.

Fore Example

Executing the example requires that the repository contains a modeling container with the MS identifier. A model with the MODEL_D identifier calculated by the method of determinate equation and containing at least one input variable must be available in this container.

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

Mb := MetabaseClass.Active;

ModelSpace := Mb.ItemById("MS").Bind;

ModelObj := Mb.ItemByIdNamespace("MODEL_D", ModelSpace.Key).Edit;

Model := ModelObj As IMsModel;

Transf := Model.Transform;

Formula := Transf.FormulaItem(0);

Determ := Formula.Method As IMsDeterministicTransform;

TransVar := Transf.Inputs.Item(0);

Slice := TransVar.Slices.Item(0);

TermInfo := Transf.CreateTermInfo;

TermInfo.Slice := Slice;

TermInfo.Type := MsFormulaTermType.Pointwise;

Expr := Determ.Expression;

Expr.References := "Ms";

Expr.AsString := "PchY(" + TermInfo.TermInnerText + ")";

If Expr.Valid

Then ModelObj.Save;

Else Debug.WriteLine(The model is not saved: error in the formula);

End If;

End Sub UserProc;

After executing the example the model calculates rate of change of the first input variable points to the corresponding period of 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 previous year.

Use: it can be used in formulas of calculated series of time series database and model formulas of modeling container that is a child of the time series database.

Expression 2:

PchY(X1)

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

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