IModelling.SignI

Syntax

SignI(Input: Variant): Variant;

Parameters

Input. Variable.

Description

The SignI method returns sign of selected variable points, if this variable contains only integer values.

Comments

The method can return the following values:

1. Positive number.
0. Number is equal to zero.
-1. Negative number.

Use the IModelling.Sign method to get sign of 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.

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
    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;
    Expr := Determ.Expression;
    Expr.References := "Ms";
    Expr.AsString := "SignI(" + TermInfo.TermInnerText + ")";
    If Expr.Valid
         Then ModelObj.Save;
        Else Debug.WriteLine(Model is not saved: error in formula);
    End If;
End Sub UserProc;

After executing the example the model will calculate sign of the first input variable points, if it contains only integer values.

Example of Use in Expressions

Expression 1:

SignI({Brazil|BCA})

Result: the signs of Brazil|BCA factor observations are calculated. If the factor contains real values, the error occurs.

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

Expression 2:

SignI(X1)

Result: the signs of of X1 factor points are calculated.

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