IModelling.AutoTrend

Syntax

AutoTrend(Input: ITimeSeries; Period: IMsPeriod): Variant;

Parameters

Input. The variable, which optimal trend must be autoselected.

Period. The period, at which optimal trend is autoselected.

Description

The AutoTrend method selects optimal trend for the variable in the specified period.

Comments

If the Period parameter is set to Null, the method is calculated at the entire time 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 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
    Mb := MetabaseClass.Active;
    ModelSpace := Mb.ItemById("MS").Bind;
    ModelObj := Mb.ItemByIdNamespace("MODEL", ModelSpace.Key).Edit;
    Model := ModelObj As IMsModel;
    Transf := Model.Transform;
    Formula := Transf.FormulaItem(0);
    Determ := Formula.Method As IMsDeterministicTransform;
    TransVar := Transf.Inputs.Item(0);
    Slice := TransVar.Slices.Item(0);
    TermInfo := Transf.CreateTermInfo;
    TermInfo.Slice := Slice;
    Expr := Determ.Expression;
    Expr.References := "Ms;Stat";
    Expr.AsString := "AutoTrend(" + TermInfo.TermInnerText + ",SetPeriod(" + """" + "01.01.2003" + """" + "," + """" + "01.01.2006" + """" + "))";
    If Expr.Valid
        Then ModelObj.Save;
        Else Debug.WriteLine(Model is not saved: error in formula);
    End If;
End Sub UserProc;

After executing the example optimal trend is selected for the input variable at the period from 2003 to 2006.

Example of Use in Expressions

Expression 1:

AutoTrend({Brazil|BCA}, SetPeriod("2006A", "2009A"))

Result: optimal trend is selected for the Brazil|BCA series at the period from 2006 to 2009.

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

Expression 2:

AutoTrend(X1,SetPeriod("2006A", "2009A"))

Result: optimal trend is selected for the X1 factor at the period from 2006 to 2009.

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