SumI(Parameters: Array): Variant;
SumI(Context: Prognoz.Platform.Interop.Fore.ForeRuntimeContext; Parameters: System.Array): object;
Context. Context. The parameter is used only in Fore.NET.
Parameters. Variables, which sum must be calculated.
The SumI method returns the sum of corresponding points for two or more variables if they contain only integer values.
Variables in Parameters must be separated via comma.
A calculated 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:
True. Calculation does not take into account empty values.
False. Default value. Calculation takes into account empty values.
Use the IModelling.Sum method to calculate the sum of corresponding points for variables containing not only integer values.
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 and the second input variables must contain only integer values.
Add links to the Metabase, Ms system assemblies.
Sub UserSumI;
Var
Mb: IMetabase;
ModelSpace, ModelObj: IMetabaseObject;
Transf: IMsFormulaTransform;
Formula: IMsFormula;
Model: IMsModel;
Determ: IMsDeterministicTransform;
Term: IMsFormulaTerm;
Inp_1, Inp_2: String;
Expr: IExpression;
Begin
Mb := MetabaseClass.Active;
// 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
Term := Determ.Operands.Item(0);
Inp_1 := Term.TermToInnerText;
// Get the second input variable
Term := Determ.Operands.Item(1);
Inp_2 := Term.TermToInnerText;
// Set expression for calculation
Expr := Determ.Expression;
Expr.References := "Ms";
Expr.AsString := "SumI(" + Inp_1 + "," + Inp_2 + ", True)";
If Expr.Valid
Then ModelObj.Save;
Else Debug.WriteLine(Model is not saved: error in formula);
End If;
End Sub UserSumI;
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;
Term: IMsFormulaTerm;
Inp_1, Inp_2: 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
Term := Determ.Operands.Item[0];
Inp_1 := Term.TermToInnerText();
// Get the second input variable
Term := Determ.Operands.Item[1];
Inp_2 := Term.TermToInnerText();
// Set expression for calculation
Expr := Determ.Expression;
Expr.References := "Ms";
Expr.AsString := "SumI(" + Inp_1 + "," + Inp_2 + ", True)";
If Expr.Valid
Then ModelObj.Save();
Else System.Diagnostics.Debug.WriteLine("Model is not saved: error in formulaquot;);
End If;
End Sub;
After executing the example the model calculates the sum of corresponding points for the first and the second input variables without taking into account empty values.
Expression 1:
SumI({Brazil|BCA},{China|BCA},{Sudan|BCA})
Result: the sum of corresponding observations of the series: Brazil|BCA, China|BCA and Sudan|BCA. If any of time series contains the real values, an 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:
SumI(X1,X2,True)
Result: the sum of corresponding points of the X1 and X2 factors without taking into account empty values.
Use: it can be used in model variable-based formulas of modeling container.
Expression 3:
SumI(4,2,5,-3)
Result: 8.
Application: it can be used in any expressions.
See also:
IModelling | Time Series Database: Calculator | Modeling Container: Editing Regressor or Formula