IModelling.AverageI

Syntax

AverageI(Parameters: Array): Variant;

Parameters

Parameters. Variable.

Description

The AverageI method returns the average of selected variable points if this variable contains only integer values.

Comments

If more than one variable is specified in Parameters, the average of corresponding variable points is calculated. For example, the average of points of 2018 by all variables.

Variables in Parameters must be separated via comma.

A calculation period can be set for the method. To do this, use the IModelling.SetPeriod method, by specifying it at any place of input array.

To calculate the method without taking into account empty values, use the IgnoreMissing parameter by specifying it in any place of the input array. Available values of the parameter:

Use the IModelling.Average method to calculate average of points of the variable containing not only integer values.

Example

Executing the example requires that the repository contains a modeling container with the MS identifier. This contains includes a model with the MODEL_D identifier that is calculated by the determinate equation method and contains more than one input variable.

The first input variable must contain only integer values.

Add links to the Metabase and Ms system assemblies.

Sub UserAverageI;
Var
    Mb: IMetabase;
    ModelSpace, ModelObj: IMetabaseObject;
    Transf: IMsFormulaTransform;
    Formula: IMsFormula;
    Model: IMsModel;
    Determ: IMsDeterministicTransform;
    TransVar: IMsFormulaTerm;
    Inp_1: String;
    Expr: IExpression;
Begin
    Mb := MetabaseClass.Active;
    // Get model
    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;
    // Get the first input variable
    TransVar := Determ.Operands.Item(0);
    Inp_1 := TransVar.TermToInnerText;
    // Get the second input variable
    TransVar := Determ.Operands.Item(1);
    // Set calculation formula
    Expr := Determ.Expression;
    Expr.References := "Ms";
    Expr.AsString := TransVar.TermToInnerText + "+AverageI(" + Inp_1 + ")";
    If Expr.Valid
        Then ModelObj.Save;
        Else Debug.WriteLine("The model is not saved: error in formula");
    End If;
End Sub UserAverageI;

After executing the example the model calculates values of the second input variable increased by the average of the first input variable.

Example of Use in Expressions

Expression 1:

AverageI({Brazil|BCA},False)

Result: the average value of the Brazil|BCA series observations is calculated taking into account empty values. If the series contains real values, an error occurs.

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

Expression 2:

AverageI(X1, SetPeriod(2000,2010))

Result: the average value of the X1 factor points is calculated for the period from 2000 to 2010.

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

Expression 3:

AverageI(1, 2, 1, 7)

Result: 3.

Application: it can be used in any expressions.

See also:

IModelling | Time Series Database: Calculator | Modeling container: Editing Regressor or Formula