Core.Terms.ToInteger

From emotive
Revision as of 08:15, 26 April 2019 by Nb (talk | contribs)
Jump to navigation Jump to search

Classification

Name ToInteger
Short Description Converts an OTX term to a value of the Integer data type
Class Term
Extension OTX Core library
Group Conversion terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

IntegerTerm = Conversion.ToInteger(Term);

Description

This term will return the Integer counterpart of the argument term.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
Integer Returns the Integer counterpart of the argument term.

Rules

  • Boolean
    Returns 1 if true , otherwise 0
  • Integer
    Returns a copy of the value
  • Float
    Return the integer part (value) left beside the point. The decimal part is this truncated and not rounded.
  • ByteField
    Returns the integer value of the ByteFields. The byte sequence is interpreted unsigned.
  • String
    Returns the integer value of the string. The string must conform to an IntegerLiteral. If not, an exception is thrown.

Properties

Name Data Type Class Default Cardinality Description
Term - Term - [1] Represents the OTX term that will be converted to a new value of the Integer data type. See conversion rule descriptions above.

OTL Examples

Integer Integer1;
Integer Integer2;
Integer Integer3;
Integer Integer4;

Integer1 = Conversion.ToInteger(true);
Integer2 = Conversion.ToInteger("1234");
Integer3 = Conversion.ToInteger(123.456);
Integer4 = Conversion.ToInteger(&18 00 FF FF);

See also

ToBoolean
ToFloat
ToByteField
ToString