IModelling.Truncate

Syntax

Truncate(Input: ITimeSeries;
Period: IMsPeriod;
Mode: MsTruncateMode): Variant;

Parameters

Input. Truncated variable.

Period. Truncation period.

Mode. Truncation mode.

Description

The Truncate method truncates variable in accordance with selected parameters.

Comments

If the Period parameter is set to Null, the truncation is executed at 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_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
    Mb := MetabaseClass.Active;
    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;
    TransVar := Transf.Inputs.Item(0);
    Slice := TransVar.Slices.Item(0);
    TermInfo := Transf.CreateTermInfo;
    TermInfo.Slice := Slice;
    Expr := Determ.Expression;
    Expr.References := "Ms";
    Expr.AsString := "Truncate(" + TermInfo.TermInnerText + ", SetPeriod(" + """" + "01.01.2003" +
                              """" + "01.01.2006" + """" + ")" + ", MsTruncateMode.Remove)";
    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 the model will truncate the first input variable for the period from 2003 to 2006.

Example of Use in Expressions

Expression 1:

Truncate({Brazil|BCA[t]}, SetPeriod("2006A", "2009A"), MsTruncateMode.Remove)

Result: the Brazil|BCA series is truncated (values from 2006 to 2009 are discarded).

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

Expression 2:

Truncate(X1,SetPeriod("2006A", "2009A"), MsTruncateMode.Keep)

Result: the X1 factor is truncated (values from 2006 to 2009 are kept).

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