IModelling.FloorI

Fore Syntax

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

Fore.NET Syntax

FloorI(Input: object;
Precision: object;
Context: Prognoz.Platform.Interop.Fore.ForeRuntimeContext): object;

Parameters

Input. The variable, which points must be rounded.

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

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

Description

The FloorI method returns the result of rounding down variable points to multiple of the specified accuracy. The variable must only contain integer values.

Comments

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

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

Add links to the Metabase, Ms system assemblies.

Sub UserFloorI;
Var
    Mb: IMetabase;
    ModelSpace, ModelObj: IMetabaseObject;
    Transf: IMsFormulaTransform;
    Formula: IMsFormula;
    Model: IMsModel;
    Determ: IMsDeterministicTransform;
    Term: IMsFormulaTerm;
    Expr: IExpression;
Begin
    Mb := MetabaseClass.Active;
    // Get model
    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;
    // Get the first input variable
    Term := Determ.Operands.Item(0);
    // Set calculation formula
    Expr := Determ.Expression;
    Expr.References := "Ms";
    Expr.AsString := "FloorI(" + Term.TermToInnerText + ", 3)";
    If Expr.Valid
        Then ModelObj.Save;
        Else Debug.WriteLine("The model is not saved: error in formula");
    End If;
End Sub UserFloorI;

After executing the example the model rounds down values of the first input variable points to the nearest multiple of three.

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;
    Term: IMsFormulaTerm;
    Expr: IExpression;
Begin
    Mb := Params.Metabase;
    // Get the model
    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;
    // Get the first input variable
    Term := Determ.Operands.Item[0];
    // Set calculation formula
    Expr := Determ.Expression;
    Expr.References := "Ms";
    Expr.AsString := "FloorI(" + Term.TermToInnerText() + ", 3)";
    If Expr.Valid
        Then ModelObj.Save();
        Else System.Diagnostics.Debug.WriteLine("Model is not saved: error in formulaquot;);
    End If;
End Sub;

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 calculated series of time series database and model formulas of modeling container that is a child of the time series database.

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.