IModelling.Floor

Syntax

Floor(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 Floor method returns the result of rounding down variable points to multiple of the specified accuracy.

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.

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

Mb := MetabaseClass.Active;

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;

TransVar := Transf.Inputs.Item(0);

Slice := TransVar.Slices.Item(0);

TermInfo := Transf.CreateTermInfo;

TermInfo.Slice := Slice;

TermInfo.Type := MsFormulaTermType.Pointwise;

Expr := Determ.Expression;

Expr.References := "Ms";

Expr.AsString := "Floor(" + TermInfo.TermInnerText + ", 3)";

If Expr.Valid

Then ModelObj.Save;

Else Debug.WriteLine(The model is not saved: error in the formula);

End If;

End Sub UserProc;

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

Example of Use in Expressions

Expression 1:

Floor({Brazil|BCA},3)

Result: Brazil|BCA factor observations are rounded down to the nearest number that is multiple of three.

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:

Floor(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.

See also:

IModelling