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 ToBoolean(Term)
Description
This term will return the Boolean counterpart of the argument term.
Return Value
The Term returns the value, see table below.
|
|
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
- Returns false if 0, otherwise true .
- Float
- Returns false if 0.0, otherwise true .
- ByteField
- Returns false if empty, otherwise true .
- String
- Returns true if the string value is "true", ignoring case, otherwise false .
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 Boolean data type. See conversion rule descriptions above.
|
OTL Examples
/// Global Declarations
Boolean Boolean1;
Boolean Boolean2;
Boolean Boolean3;
Boolean Boolean4;
Boolean Boolean5;
/// Flow
Boolean1 = ToBoolean(true);
Boolean2 = ToBoolean(0);
Boolean3 = ToBoolean(0.00001);
Boolean4 = ToBoolean(&00);
Boolean5 = ToBoolean("tRuE");
See also
ToInteger
ToFloat
ToByteField
ToString