IModelling.FloorI

Syntax

FloorI(Input: Variant; Precision: Variant): Variant;

Parameters

Input. The variable, which points must be rounded.

Precision. The multiple, to which it is necessary to round.

Description

The FloorI method returns the result of rounding down variable points to the multiply with the specified accuracy if the variable contains only integer values.

Comments

Use the IModelling.Floor method to round points of the variable containing not only integer values.

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. The first input variable should contain only integer values.

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 := "(FloorI(" + TermInfo.TermInnerText + ", 3)";
    // 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 UserProc;

After executing the example the model will round down values of the first input variable points to the nearest number that is multiple of three.

Example of Use in Expressions

Expression 1:

FloorI({Brazil|BCA},3)

Result: Brazil|BCA factor observations are rounded down to the nearest number that is multiple of three. An error occurs if the factor contains real values.

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

Expression 2:

FloorI(X1,2)

Result: X1 factor points are rounded down to the nearest number that is multiple of two.

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