IModelling.Truncate

Fore Syntax

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

Fore.NET Syntax

Truncate(Input: Prognoz.Platform.Interop.Ms.TimeSeries;
         Period: Prognoz.Platform.Interop.Ms.IMsPeriod;
         Mode: Prognoz.Platform.Interop.Ms.MsTruncateMode;
         Context: Prognoz.Platform.Interop.Fore.ForeRuntimeContext): ojbject;

Parameters

Input. Truncated variable.

Period. Truncation period.

Mode. Truncation mode.

Context. Context. The parameter is used only in Fore.NET.

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.

Fore Example

Executing the example requires that the repository contains a modeling container with the MS identifier. A model with the MODEL_D identifier calculated by the method of determinate equation and containing at least one input variable must be available in this container.

Add links to the Metabase, 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;
    TermInfo.Type := MsFormulaTermType.Pointwise;
    Expr := Determ.Expression;
    Expr.References := "Ms;Stat";
    Expr.AsString := "Truncate(" + TermInfo.TermInnerText + ",SetPeriod(" + """" + "01.01.2003" + """" + "," + """" + "01.01.2006" + """" + "), MsTruncateMode.Remove)";
    If Expr.Valid
        Then ModelObj.Save;
        Else Debug.WriteLine("The model is not saved: error in formula");
    End If;
End Sub UserProc;

After executing the example the model truncates the first input variable for the period from 2003 to 2006.

Fore.NET Example

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;
    TransVar: IMsFormulaTransformVariable;
    Slice: IMsFormulaTransformSlice;
    TermInfo: IMsFormulaTermInfo;
    Expr: IExpression;
Begin
    Mb := Params.Metabase;
    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;
    TermInfo.Type := MsFormulaTermType.mfttPointwise;
    Expr := Determ.Expression;
    Expr.References := "Ms;Stat";
    Expr.AsString := "Truncate(" + TermInfo.TermInnerText + ",SetPeriod(" + """" + "01.01.2003" + """" + "," + """" + "01.01.2006" + """" + "), MsTruncateMode.Remove)";
    If Expr.Valid
        Then ModelObj.Save();
        Else System.Diagnostics.Debug.WriteLine("Model is not saved: error in formula");
    End If;
End Sub;

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 calculated series of time series database and in formulas of attribute-based models of modeling container.

Expression 2:

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

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

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