IModelling.YearSeries

Syntax

YearSeries([OutputFrequency: MsFrequency = 0]): Variant;

Parameters

OutputFrequency. Calendar frequency of output series.

Description

The YearSeries method returns the current year value for each series point depending on the set calculation periods.

Comments

If the OutputFrequency parameter is set to 0, the output series is created with the current series frequency.

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 := "iif(YearSeries(MsFrequency.Annual)>=2010," + TermInfo.TermInnerText + ",0)";
    // Check if the expression is correct
    If Expr.Valid
        // If the expression is set correctly, save the model
        Then ModelObj.Save;
        // If expression is not correct, output message to console window
        Else Debug.WriteLine("Model is not saved: error in the formula");
    End If;
End Sub UserProc;

After executing the example the formula is changed for the model. For values before 2010 year, the model will return zeros and starting with 2010 year - the first factor value.

Example of Use in Expressions

Expression 1:

YearSeries

Calculation period: 2009-2013; calculation frequency: annual. Result: [2009, 2010, 2011, 2012, 2013].

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

Expression 2:

iif(yearseries(MsFrequency.Annual) < 2015, X1, 0)

Result: for values before 2015 year the expression returns the X1 factor values and from 2015 year - it returns zeros.

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