IModelling.Combine

Syntax

Combine(Forecast: IMsForecast; Period: IMsPeriod): Variant;

Parameters

Forecast. Forecasting series.

Period. Data forecasting period.

Description

The Combine method returns the series containing source series data for the sample period and forecasting series data for the forecasting period.

Comments

If sample and forecasting periods are intersected, forecasting data has higher priority. Thus, the returned series will include truncated date at sample period and full data at forecasting period.

Example

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 the determinate equation method and contains at least one input variable.

Add links to the Metabase and Ms system assemblies.

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
    // Get repository
    Mb := MetabaseClass.Active;
    // Get modeling container
    ModelSpace := Mb.ItemById("MS").Bind;
    // Get the model
    ModelObj := Mb.ItemByIdNamespace("MODEL_D", ModelSpace.Key).Edit;
    Model := ModelObj As IMsModel;
    // Get model calculation parameters
    Transf := Model.Transform;
    Formula := Transf.FormulaItem(0);
    Determ := Formula.Method As IMsDeterministicTransform;
    // Get the first input variable
    TransVar := Transf.Inputs.Item(0);
    Slice := TransVar.Slices.Item(0);
    TermInfo := Transf.CreateTermInfo;
    TermInfo.Slice := Slice;
    // Set mode of passing variable into calculation
    TermInfo.Type := MsFormulaTermType.Pointwise;
    // Get model calculation expression
    Expr := Determ.Expression;
    Expr.References := "Ms";
    // Set model calculation expression
    Expr.AsString := "Combine(Arima(" + TermInfo.TermInnerText +
        ", Default_, """ + "" + """, """ + "1" + """, 0, Estimate), SetPeriod(" +
        """" + "01.01.2010" + """" + "," + """" + "01.01.2015" + """" +
        "))";
    // Check if the expression is correct
    If Expr.Valid
        // If the expression is set correctly, save the model
        Then ModelObj.Save;
        // If the expression is incorrect, display a message to the console window
        Else Debug.WriteLine("Model is not saved: error in the formula");
    End If;
End Sub UserProc;

After executing the example the model will return a series containing source series data at sample period and containing forecasting series data at specified forecasting period for the ARIMA method.

Example of Use in Expressions

Expression 1:

Combine(Arima({GDP|Anchorage[t]}, Default_, "", "1", 0, Estimate), SetPeriod("01.01.2010", "01.01.2015"))

Result: the series containing source series data at sample period and containing forecasting series data at specified forecasting period will be obtained for the ARIMA model.

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

Expression 2:

Combine(Arima(X1, Default_, "", "1", 0, Estimate), SetPeriod("01.01.2010", "01.01.2015"))

Result: the series containing source series data at sample period and containing forecasting series data at specified forecasting period will be obtained for the ARIMA model.

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