Yate functions requiring numeric values convert the text at the start of a field to an integer. If an integer cannot be constructed, 0 is assumed. This function saves the results of the conversion ignoring extra characters after the integer. The function can read decimal integer sequences and Roman numeral sequences. The function can output the integer as a decimal integer or Roman numeral.
You specify a variable or named variable to be converted. If a named variable is specified it may contain any of the escape sequences described in Escape Sequences.
The following modes are available:
- as integer no padding
- A decimal integer is extracted and represented as is. eg. 4 Title --> 4
- as integer padded to two digits
- A decimal integer is extracted. Positive integers in the range of 0 to 99 are represented as two digits. All other integers are represented as is. eg. 4 Title --> 04
- as integer padded to three digits
- A decimal integer is extracted. Positive integers in the range of 0 to 999 are represented as three digits. All other integers are represented as is. eg. 4 Title --> 004
- as integer padded to four digits
- A decimal integer is extracted. Positive integers in the range of 0 to 9999 are represented as four digits. All other integers are represented as is. eg. 4 Title --> 0004
- as integer from Roman numeral
- A Roman numeral sequence is converted to a decimal integer. The string is treated as case insensitive and leading and trailing spaces are ignored. The conversion stops with the first non Roman numeral digit or the end of the string. An invalid Roman numeral sequence will return 0. The alternative forms IIII, IIIII, XXXX, XXXXX, CCCC, CCCCC are permitted. eg. XIV --> 14
- as Roman numeral
- A decimal integer is extracted and represented as a Roman numeral. Only positive integers in the range of 1 to 3999 can be represented. Any other value will be returned as an empty string. eg. 14 --> XIV