Structured Text Function List

The sections below detail the built-in functions and function blocks available in Productivity Suite Structured Text editor.

Note: Function blocks are similar to ladder instructions.

There are eight categories of functions and function blocks:

Logical
Math
String
Application
Array
Data Handling
Standard
Advanced

Note: In the sections below, the INTEGER parameter type can refer to any of the following data types:
• Integer, 8 Bit Unsigned
• Integer, 16 Bit
• Integer, 16 Bit Unsigned
• Integer, 32 Bit
• Float, 32 Bit
• Integer, 16 Bit BCD
• Integer, 32 Bit BCD

result := F_TRIG(input);

Parameter	Type	Required	Description
input	BOOLEAN	Required	Watched input

Returns TRUE if a falling edge is detected on the input.

result := R_TRIG(input);

Parameter	Type	Required	Description
input	BOOLEAN	Required	Input signal

Returns TRUE if a rising edge is detected on the input.

result := ABS(value);

Parameter	Type	Required	Description
value	INTEGER	Required	Input number

result := ACOS(value);

Parameter	Type	Required	Description
value	INTEGER	Required	Number between -1 and 1

result := ACOSR(value);

Parameter	Type	Required	Description
value	INTEGER	Required	Number between -1 and 1

result := AND(value1, value2);

Parameter	Type	Required	Description
value1	INTEGER	Required	First integer
value2	INTEGER	Required	Second integer

result := ASIN(value);

Parameter	Type	Required	Description
value	INTEGER	Required	Number between -1 and 1

result := ASINR(value);

Parameter	Type	Required	Description
value	INTEGER	Required	Number between -1 and 1

result := ATAN(value);

Parameter	Type	Required	Description
value	INTEGER	Required	Any number

result := ATANR(value);

Parameter	Type	Required	Description
value	INTEGER	Required	Any number

result := AVERAGE(value1, value2 [, value3, ..., value16]);

Parameter	Type	Required	Description
value1	INTEGER	Required	Value #1
value2	INTEGER	Required	Value #2
value3..16	INTEGER	Optional	Additional values (up to 16 total)

result := CEIL(value);

Parameter	Type	Required	Description
value	INTEGER	Required	Input number

result := COS(degrees);

Parameter	Type	Required	Description
degrees	INTEGER	Required	Angle in degrees

result := COSR(radians);

Parameter	Type	Required	Description
radians	INTEGER	Required	Angle in radians

result := DEG(radians);

Parameter	Type	Required	Description
radians	INTEGER	Required	Angle in radians

result := E();

The constant value 2.71828182… (Euler's number e). No parameters required.

result := FLOOR(value);

Parameter	Type	Required	Description
value	INTEGER	Required	Input number

result := INV(value);

Parameter	Type	Required	Description
value	INTEGER	Required	Input number

result := LN(value);

Parameter	Type	Required	Description
value	INTEGER	Required	Input number

result := LOG(value);

Parameter	Type	Required	Description
value	INTEGER	Required	Input number

result := MAX(value1, value2 [, value3, ..., value16]);

Parameter	Type	Required	Description
value1	INTEGER	Required	Value #1
value2	INTEGER	Required	Value #2
value3..16	INTEGER	Optional	Additional values (up to 16 total)

result := MEDIAN(value1, value2 [, value3, ..., value16]);

Parameter	Type	Required	Description
value1	INTEGER	Required	Value #1
value2	INTEGER	Required	Value #2
value3..16	INTEGER	Optional	Additional values (up to 16 total)

result := MIN(value1, value2 [, value3, ..., value16]);

Parameter	Type	Required	Description
value1	INTEGER	Required	Value #1
value2	INTEGER	Required	Value #2
value3..16	INTEGER	Optional	Additional values (up to 16 total)

result := MROUND(value, decimal_points);

Parameter	Type	Required	Description
value	INTEGER	Required	Input number
decimal_points	INTEGER	Required	Decimal points to round to

result := MROUNDDN(value, decimal_points);

Parameter	Type	Required	Description
value	INTEGER	Required	Input number
decimal_points	INTEGER	Required	Decimal points to round to

result := MROUNDUP(value, decimal_points);

Parameter	Type	Required	Description
value	INTEGER	Required	Input number
decimal_points	INTEGER	Required	Decimal points to round to

result := OR(value1, value2);

Parameter	Type	Required	Description
value1	INTEGER	Required	First integer
value2	INTEGER	Required	Second integer

result := PI();

The constant value 3.14159265… No parameters required.

result := RAD(degrees);

Parameter	Type	Required	Description
degrees	INTEGER	Required	Angle in degrees

result := RANDOM();

No parameters required.

result := SDEV(value1, value2 [, value3, ..., value16]);

Parameter	Type	Required	Description
value1	INTEGER	Required	Value #1
value2	INTEGER	Required	Value #2
value3..16	INTEGER	Optional	Additional values (up to 16 total)

result := SIN(degrees);

Parameter	Type	Required	Description
degrees	INTEGER	Required	Angle in degrees

result := SINR(radians);

Parameter	Type	Required	Description
radians	INTEGER	Required	Angle in radians

result := SQRT(value);

Parameter	Type	Required	Description
value	INTEGER	Required	Input number

Note: Square root of a negative number will evaluate as zero (0)

result := TAN(degrees);

Parameter	Type	Required	Description
degrees	INTEGER	Required	Number not n*180 + 90

result := TANR(radians);

Parameter	Type	Required	Description
radians	INTEGER	Required	Number not n*PI + PI/2

result := TRUNCATE(value);

Parameter	Type	Required	Description
value	INTEGER	Required	Input number

result := XOR(value1, value2);

Parameter	Type	Required	Description
value1	INTEGER	Required	First integer
value2	INTEGER	Required	Second integer

result := ANY_TO_STRING(input, string_length, decimal_points);

Parameter	Type	Required	Description
input	INTEGER	Required	Number to be converted
string_length	INTEGER	Required	Length of output string
decimal_points	INTEGER	Required	Constant, number of decimal points

result := CMPS(string1, string2, string_length);

Parameter	Type	Required	Description
string1	STRING	Required	String #1
string2	STRING	Required	String #2
string_length	INTEGER	Required	Number of characters to compare

Returns TRUE if contents are equal.

result := CONCAT(string1, string2 [, string3, ..., string16]);

Parameter	Type	Required	Description
string1	STRING	Required	String #1
string2	STRING	Required	String #2
string3..16	STRING	Optional	Additional strings (up to 16 total)

result := CPAS(input);

Parameter	Type	Required	Description
input	1D INTEGER ARRAY	Required	Integer array

result := CPSA(input);

Parameter	Type	Required	Description
input	STRING	Required	Input string

result := DECIMAL(string);

Parameter	Type	Required	Description
string	STRING	Required	String to be converted

result := DELETE(string, L, N);

Parameter	Type	Required	Description
string	STRING	Required	Input string
L	INTEGER	Required	Number of characters to delete
N	INTEGER	Required	Beginning position

result := FIND(string1, string2);

Parameter	Type	Required	Description
string1	STRING	Required	String to be searched
string2	STRING	Required	String to be found

Returns position of the found string, or 0 if not found.

result := FNDH(string, value, start, end, instance);

Parameter	Type	Required	Description
string	STRING	Required	String to be searched
value	INTEGER	Required	Hex value to find (range 0 to 0xFFFF)
start	INTEGER	Required	Position in string to start search
end	INTEGER	Required	Position in string to end search
instance	INTEGER	Required	Which instance of value to find

Returns position of the found hex value, or 0 if not found.

result := INSERT(string1, string2, N);

Parameter	Type	Required	Description
string1	STRING	Required	String to be inserted into
string2	STRING	Required	Inserting string
N	INTEGER	Required	Starting position

result := LEFT(string, N);

Parameter	Type	Required	Description
string	STRING	Required	Input string
N	INTEGER	Required	Number of leftmost characters

result := MID(string, L, P);

Parameter	Type	Required	Description
string	STRING	Required	Input string
L	INTEGER	Required	Length of string
P	INTEGER	Required	Starting position

result := REPLACE(string1, string2, L, N);

Parameter	Type	Required	Description
string1	STRING	Required	String to be replaced in
string2	STRING	Required	Replacing string
L	INTEGER	Required	Number of characters to replace
N	INTEGER	Required	Beginning position

result := RIGHT(string, N);

Parameter	Type	Required	Description
string	STRING	Required	Input string
N	INTEGER	Required	Number of rightmost characters

result := SLEN(string);

Parameter	Type	Required	Description
string	STRING	Required	Input string

result := LIM(min, input, max);

Parameter	Type	Required	Description
min	INTEGER	Required	Minimum value
input	INTEGER	Required	Input value
max	INTEGER	Required	Maximum value

result := SEL(flag, input_1, input_2);

Parameter	Type	Required	Description
flag	BOOLEAN	Required	Selection flag
input_1	INTEGER	Required	Value returned when flag is TRUE
input_2	INTEGER	Required	Value returned when flag is FALSE

result := SUM(input_1, select_1 [, input_2, select_2, ..., input_8, select_8]);

Parameter	Type	Required	Description
input_1	INTEGER	Required	Input value #1
select_1	BOOLEAN	Required	Selection flag #1
input_2..8	INTEGER	Optional	Input value #2 through #8
select_2..8	BOOLEAN	Optional	Selection flag #2 through #8

Accepts up to 8 input/select pairs. Only inputs with their corresponding select flag set to TRUE are included in the sum.

BINCPA (source_array, destination_array, src_start_col, src_end_col, dest_start_col [, src_start_row, src_end_row, dest_start_row, overflow]);

Parameter	Type	Required	Description
source_array	NUM_ARRAY	Required	Source array
destination_array	NUM_ARRAY	Required	Destination array
src_start_col	INTEGER	Required	Source starting column index
src_end_col	INTEGER	Required	Source ending column index
dest_start_col	INTEGER	Required	Destination starting column index
src_start_row	INTEGER	Optional	Source starting row index
src_end_row	INTEGER	Optional	Source ending row index
dest_start_row	INTEGER	Optional	Destination starting row index
overflow	BOOLEAN	Optional	Flag enabled when index is out of bounds

Only numerical (integer and float) arrays are supported.

CPA (source_array, destination_array, src_start_col, src_end_col, dest_start_col [, src_start_row, src_end_row, dest_start_row, overflow]);

Parameter	Type	Required	Description
source_array	ANY_ARRAY	Required	Source array
destination_array	ANY_ARRAY	Required	Destination array
src_start_col	INTEGER	Required	Source starting column index
src_end_col	INTEGER	Required	Source ending column index
dest_start_col	INTEGER	Required	Destination starting column index
src_start_row	INTEGER	Optional	Source starting row index
src_end_row	INTEGER	Optional	Source ending row index
dest_start_row	INTEGER	Optional	Destination starting row index
overflow	BOOLEAN	Optional	Flag enabled when index is out of bounds

FLA(input, array, start_col, end_col [, start_row, end_row, overflow]);

Parameter	Type	Required	Description
input	INTEGER	Required	Value to fill the array with
array	NUM_ARRAY	Required	Array to be filled
start_col	INTEGER	Required	Starting column index
end_col	INTEGER	Required	Ending column index
start_row	INTEGER	Optional	Starting row index
end_row	INTEGER	Optional	Ending row index
overflow	BOOLEAN	Optional	Flag enabled when index is out of bounds

PBA(source_array, destination_array, src_start_col, src_end_col, dest_start_col [, overflow]);

Parameter	Type	Required	Description
source_array	BOOL_1D_ARRAY	Required	Source Boolean array
destination_array	INT_1D_ARRAY	Required	Destination integer array
src_start_col	INTEGER	Required	Source starting column index
src_end_col	INTEGER	Required	Source ending column index
dest_start_col	INTEGER	Required	Destination starting column index
overflow	BOOLEAN	Optional	Flag enabled when index is out of bounds

PBD(source_array, destination_array, src_start_col, src_end_col, dest_start_col [, overflow]);

Same parameter structure as PBA. Source: 8-bit Integer array, Destination: 32-bit Integer array.

PBW(source_array, destination_array, src_start_col, src_end_col, dest_start_col [, overflow]);

Same parameter structure as PBA. Source: 8-bit Integer array, Destination: 16-bit Integer array.

PWD(source_array, destination_array, src_start_col, src_end_col, dest_start_col [, overflow]);

Same parameter structure as PBA. Source: 16-bit or 32-bit Integer array, Destination: 32-bit Integer array.

RAL(array, start_col, end_col);

Parameter	Type	Required	Description
array	ARRAY_1D	Required	One dimensional array
start_col	INTEGER	Required	Starting column index
end_col	INTEGER	Required	Ending column index

RAR(array, start_col, end_col);

Parameter	Type	Required	Description
array	ARRAY_1D	Required	One dimensional array
start_col	INTEGER	Required	Starting column index
end_col	INTEGER	Required	Ending column index

SAL(array, start_col, end_col [, inflow], outflow);

Parameter	Type	Required	Description
array	ARRAY_1D	Required	One dimensional array
start_col	INTEGER	Required	Starting column index
end_col	INTEGER	Required	Ending column index
inflow	INTEGER	Optional	Value to fill the vacated element
outflow	INTEGER	Required	Element value shifted out

SAR(array, start_col, end_col [, inflow], outflow);

Parameter	Type	Required	Description
array	ARRAY_1D	Required	One dimensional array
start_col	INTEGER	Required	Starting column index
end_col	INTEGER	Required	Ending column index
inflow	INTEGER	Optional	Value to fill the vacated element
outflow	INTEGER	Required	Element value shifted out

result := STAMD(array, start_col, end_col [, start_row, end_row, ignore_less, ignore_greater, overflow]);

Parameter	Type	Required	Description
array	NUM_ARRAY	Required	Array with elements to be calculated
start_col	INTEGER	Required	Starting column index
end_col	INTEGER	Required	Ending column index
start_row	INTEGER	Optional	Starting row index
end_row	INTEGER	Optional	Ending row index
ignore_less	INTEGER	Optional	Value below which elements are ignored
ignore_greater	INTEGER	Optional	Value above which elements are ignored
overflow	BOOLEAN	Optional	Flag enabled when an index is out of bounds

result := STAMN(array, start_col, end_col [, start_row, end_row, ignore_less, ignore_greater, overflow]);