Core.Terms.ToFloat
Jump to navigation
Jump to search
Contents
Classification
Name | ToFloat |
Short Description | Converts an OTX term to a value of the Float data type |
Class | Term |
Extension | OTX Core library |
Group | Conversion terms |
Exceptions | OutOfBoundsException TypeMismatchException |
Checker Rules | - |
Standard Compliant | Yes |
Pseudo-Code Syntax
FLoatTerm ToFloat(Term)
Description
This term will return the Float 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 |
Float | Returns the Float counterpart of the argument term. |
Rules
- Boolean
- Returns 1.0, if true , otherwise 0.0 .
- Integer
- Returns a float copy of the value.
- Float
- Returns a copy of the value.
- ByteField
- Returns the float value of the ByteFields (interpretation according to IEEE 754:2008).
- String
- Returns the float value of the string. The string must correspond to a FloatLiteral. If not, the TypeMismatchException 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 Float data type. See conversion rule descriptions above. |
Examples
/// Local Declarations
Float Float1;
Float Float2;
Float Float3;
Float Float4;
Float Float5;
/// Flow
Float1 = ToFloat(true);
Float2 = ToFloat(123);
Float3 = ToFloat(123.456);
Float4 = ToFloat(&18 00 FF FF);
Float5 = ToFloat("123.456");