Truncate

Syntax

Truncate(Input: ITimeSeries,
         Period: IMsPeriod,
         Mode: MsTruncateMode)

Parameters

Input. Truncated variable.

Period. Truncation period.

Mode. Truncation mode.

Description

It truncates the variable by the specified parameters.

Comments

If the Period parameter is set to Null, the truncation is executed at entire time period.

Example

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

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

It can be used in formulas of calculated series of time series database and in formulas of attribute-based models of modeling container.
= Truncate(X1,SetPeriod("2006A", "2009A", MsTruncateMode.Keep)

The X1 factor is truncated (values from 2006 to 2009 are discarded).

It can be used in model variable-based formulas of modeling container.

See also:

Functions Available in Expression Editor │ TransformationsIModelling.Truncate