Difference between revisions of "Core.Terms.ToString"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''ToString'''}}[[Category:Core]]
 
{{DISPLAYTITLE:OTX '''ToString'''}}[[Category:Core]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | ToString | To convert an expression to a String | [[Term]] | [[Core|OTX Core library]] | [[Conversion terms]] | - | - }}
+
{{ClassificationActivity | ToString | Converts an OTX term to a value of the String data type | [[Term]] | [[Core|OTX Core library]] | [[Conversion terms]] | - | - }}
  
 
== Pseudo-Code Syntax ==
 
== Pseudo-Code Syntax ==
Line 9: Line 9:
  
 
== Description ==
 
== Description ==
Term to the convert an expression to a String.
+
This term will return the String counterpart of the argument term.
  
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | Return value of the appropriate type.}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | Returns the String counterpart of the argument term.}}
  
 
== Rules ==
 
== Rules ==
Line 32: Line 32:
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| Term | - | [[Term]] | - | [1] | The expression to be converted. Rules, see description.}}
+
{{TableRowPropertie1| Term | - | [[Term]] | - | [1] | Represents the OTX term that will be converted to a new value of the String data type. See conversion rule descriptions above.}}
 
|}
 
|}
  

Revision as of 08:14, 26 April 2019

Classification

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

Pseudo-Code Syntax

StringTerm = Conversion.ToString(Term);

Description

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

Rules

  • Boolean
    Returns "true" if true , otherwise "false"
  • Integer
    Returns a decimal number as a string
  • Float
    Returns the floating-point number as a string with a "." (Point) as the decimal separator.
  • ByteField
    Returns an interpretation of the ByteFields to UTF-8
  • String
    Returns a copy of the value
  • List
    Returns the list in the form of a ListLiterals , for example: "{1, 2, 3} '.
  • Map
    Returns the map in the form of a MapLiterals , for example: "{{key1, 1}, {key2, 2}, {key9, 123}}"

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 String data type. See conversion rule descriptions above.

Examples

String String1;
String String2;
String String3;
String String4;

String1 = Conversion.ToString(true);
String2 = Conversion.ToString("1234");
String3 = Conversion.ToString(123.456);
String4 = Conversion.ToString(&18 00 FF FF);

See also

ToBoolean
ToInteger
ToFloat
ToByteField