This function allows an alarm to be reset by also specifying the value of one or more parameters.
Syntax |
bool alarm_reset_par ([i32 nAl=0] [, i32 nAx] [, u32 parMask] [, real par1] [, real par2=0] [, real par3=0]) |
|||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nAl |
Alarm number (1-:-9999). (optional, default 0) |
|||||||||||||||||||||||||||
nAx |
Number of the axis in alarm (1-:-32). (optional, default 0) |
|||||||||||||||||||||||||||
parMask |
Mask to indicate which parameters are affected:
|
|||||||||||||||||||||||||||
par1 |
Value of the first parameter of the alarm. (optional, default 0) |
|||||||||||||||||||||||||||
par2 |
Value of the second parameter of the alarm. (optional, default 0) |
|||||||||||||||||||||||||||
par3 |
Value of the third alarm parameter. (optional, default 0) |
|||||||||||||||||||||||||||
Result |
Returns:
|
|||||||||||||||||||||||||||
Validity |
Rule, Task |
|||||||||||||||||||||||||||
Notes |
Reset operation involves: •clearing the alarm in the stack (if present) and any compaction •resetting of the alarm bit in theAM •initialization of the filter time to access the alarm history(ah_filter_time()) •adjustment of the predefined variables al_pres(), al_stack_mask() and ax_in_alarm() (if necessary) |
Example of use:
|