Core.Terms.ToBoolean

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

Classification

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

OTL Syntax

BooleanTerm = Conversion.ToBoolean(Term);

Description

This term shall return the Boolean 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
Boolean Returns the Boolean counterpart of the argument term.

Rules

  • Boolean
    Returns a copy of the value
  • Integer
    If 0, return false , otherwise true
  • Float
    If 0.0, return false , otherwise true
  • ByteField
    If empty, return false , otherwise true
  • String
    If the value of the string "True", and not taken into account - insensitive will return true , otherwise false

Properties

Name Data Type Class Default Cardinality Description
Term - Term - [1] Represents the OTX term that shall be converted to a new value of the Boolean data type.

OTL Examples

Boolean Boolean1;
Boolean Boolean2;
Boolean Boolean3;

Boolean1 = Conversion.ToBoolean(0);
Boolean2 = Conversion.ToBoolean("true");
Boolean3 = Conversion.ToBoolean("false");

See also

ToInteger
ToFloat
ToByteField
ToString