AverageI(Parameters: Array): Variant;
AverageI(Context: Prognoz.Platform.Interop.Fore.ForeRuntimeContext; Parameters: System.Array): object;
Context. Context. The parameter is used only in Fore.NET.
Parameters. Variable.
The AverageI method returns the mean value of selected variable points, if this variable contains only integer values.
The method provides a possibility to set calculation period. To do this, use the IModelling.SetPeriod method, by specifying it at any place of input array.
Use the IModelling.Average method to calculate average of points of the variable containing not only integer values.
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 method of determinate equation and containing more than one input variable. The first input variable must contain only integer values.
Add links to the Metabase, 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 that are increased by average value of the first input variable.
The requirements and result of the Fore.NET example execution match with those in the Fore example.
Imports Prognoz.Platform.Interop.ForeSystem;
Imports Prognoz.Platform.Interop.Ms;
…
Public Shared Sub Main(Params: StartParams);
Var
Mb: IMetabase;
ModelSpace, ModelObj: IMetabaseObject;
Transf: IMsFormulaTransform;
Formula: IMsFormula;
Model: IMsModel;
Determ: IMsDeterministicTransform;
TransVar: IMsFormulaTerm;
Inp_1: String;
Expr: IExpression;
Begin
Mb := Params.Metabase;
// Get the 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 System.Diagnostics.Debug.WriteLine("Model is not saved: error in formulaquot;);
End If;
End Sub;
Expression 1:
AverageI({Brazil|BCA})
Result: the average value of the Brazil|BCA series observations is calculated. If the series contains real values, error appears.
Use: it can be used in formulas of calculated series of time series database and in formulas of attribute-based models of modeling container.
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 variable-based formulas of modeling container.
Expression 3:
AverageI(1, 2, 1, 7)
Result: 3.
Use: it can be used in formulas of calculated series of time series database and modeling container models.
See also:
IModelling | Time Series Database: Calculator | Modeling container: Editing Regressor or Formula