Please enable JavaScript to view this site.

This function allows an alarm to be reset from the stack by specifying the value of one or more USV user string parameters.

All alarms in the stack that match the specified parameters will be removed.

If:

the alarm number, axis number, and parMask are 0, a full stack reset is performed

the alarm number and parMask are 0, all alarms in the specific axis are reset

the axis number and parMask are 0 and the alarm number is an axis alarm, all alarms of the different axes are cleared

the axis number and parMask are 0 and the alarm number is not an axis alarm, the specific alarm is reset

the parMask is other than 0, the specific alarm is reset if the alarm number, axis number (including 0), and parameters match

Syntax

bool alarm_reset_par_us (i32 nAl, i32 nAx, u32 parMask [, string s1=0] [, string s2=0] [, string s3=0])

nAl

Alarm number (0 or 1-:-9999).

nAx

Number of the axis in alarm (0 or 1-:-32)

parMask

Mask to indicate which parameters are affected:

Bit

Hexadecimal value

Description

0

0x00000001

No USV parameter

1

0x00000002

s1

2

0x00000004

s2

3

0x00000008

s1 and s2

4

0x00000010

s3

5

0x00000020

s1 and s3

6

0x00000040

s2 and s3

7

0x00000080

s1, s2, and s3

s1

User string to be used as the first parameter of the alarm. (optional, default 0)

s2

User string to be used as the second parameter of the alarm. (optional, default 0)

s3

User string to be used as the third parameter of the alarm. (optional, default 0)

Result

Returns:

Value

Description

TRUE

alarm cleared

alarm disabled

axis not present

FALSE

illegal alarm number

illegal or undefined axis number

alarm number or axis are 0 but parMask different from 0

alarm has no USV parameters

Validity

Rule, Task

System Requirements

From RTE 34.30.0

Note


 

  

Keyboard Navigation

F7 for caret browsing
Hold ALT and press letter

This Info: ALT+q
Page Header: ALT+h
Topic Header: ALT+t
Topic Body: ALT+b
Contents: ALT+c
Search: ALT+s
Exit Menu/Up: ESC