IModelling.RoundDown

Syntax

RoundDown(Input: Variant; Precision: Variant): Variant;

Parameters

Input. Variable.

Precision. The number of decimal places, to which a number should be rounded.

Description

The RoundDown method rounds down variable point values.

Comments

Features of setting working the Precision parameter:

If the parameter value is greater than 0, the number is rounded to the specified number of decimal places after a decimal point
If the parameter value is equal to 0, the number is rounded to the nearest integer
If the parameter value is less than 0, the number is rounded to the left of the decimal point.

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 UserNvl;
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 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 := "RoundDown(" + TermInfo.TermInnerText + ", 2)";
    // Check if the expression is correct
    If Expr.Valid
        // If the expression is set correctly, save the model
        Then ModelObj.Save;
        // If the expression is incorrect, display a message to the console window
        Else Debug.WriteLine("Model is not saved: error in the formula");
    End If;
End Sub UserNvl;

After executing the example the model will round down the first input variable points to two decimal places.

Example of Use in Expressions

Expression 1:

RoundDown({Brazil|BCA},2)

Result: Brazil|BCA factor observations are rounded down to two decimal places.

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

Expression 2:

RoundDown(X1,0)

Result: X1 factor points are rounded down to the nearest integer.

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

Expression 3:

RoundDown(5.978,2)

Result: 5.97.

Application: it can be used in any expressions.