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. The variables, which sum should be found. Two and more variables must be specified via comma.
The SumI method returns the sum of corresponding points for two or more variables if they contain 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.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 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 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 + ")";
If Expr.Valid
Then ModelObj.Save;
Else Debug.WriteLine(Model is not saved: error in formula);
End If;
End Sub UserSumI;
After executing the example, the model calculates sum of the appropriate points for the first and second input variables.
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;
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 + ")";
If Expr.Valid
Then ModelObj.Save();
Else System.Diagnostics.Debug.WriteLine("Model is not saved: error in formulaquot;);
End If;
End Sub;
Expression 1:
SumI({Brazil|BCA},{China|BCA},{Sudan|BCA})
Result: sum of corresponding observations of the Brazil|BCA, China|BCA and Sudan|BCA series. 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)
Result: the sum of corresponding X1 and X2 factor points.
Use: it can be used in model variable-based formulas of modeling container.
Expression 3:
SumI(4,2,5,-3)
Result: 8.
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