Midas Alarm Functions (al_xxx)


Functions

INT al_trigger_alarm (char *alarm_name, char *alarm_message, char *default_class, char *cond_str, INT type)
INT al_reset_alarm (char *alarm_name)
INT al_check ()


Function Documentation

INT al_check (  ) 

Scan ODB for alarms.

Returns:
AL_SUCCESS

Definition at line 478 of file alarm.c.

Referenced by cm_yield().

INT al_reset_alarm ( char *  alarm_name  ) 

Reset (acknoledge) alarm.

Parameters:
alarm_name Alarm name, defined in /alarms/alarms
Returns:
AL_SUCCESS, AL_RESETE, AL_INVALID_NAME

Definition at line 390 of file alarm.c.

INT al_trigger_alarm ( char *  alarm_name,
char *  alarm_message,
char *  default_class,
char *  cond_str,
INT  type 
)

Trigger a certain alarm.

 ...
  lazy.alarm[0] = 0;
  size = sizeof(lazy.alarm);
  db_get_value(hDB, pLch->hKey, "Settings/Alarm Class", lazy.alarm, &size, TID_STRING, TRUE);

  // trigger alarm if defined
  if (lazy.alarm[0])
    al_trigger_alarm("Tape", "Tape full...load new one!", lazy.alarm, "Tape full", AT_INTERNAL);
  ...
Parameters:
alarm_name Alarm name, defined in /alarms/alarms
alarm_message Optional message which goes with alarm
default_class If alarm is not yet defined under /alarms/alarms/<alarm_name>, a new one is created and this default class is used.
cond_str String displayed in alarm condition
type Alarm type, one of AT_xxx
Returns:
AL_SUCCESS, AL_INVALID_NAME

Definition at line 176 of file alarm.c.

Referenced by al_check().


Midas DOC Version 2.0.2 ---- PSI Stefan Ritt ----
Contributions: Pierre-Andre Amaudruz - Sergio Ballestrero - Suzannah Daviel - Doxygen - Peter Green - Qing Gu - Greg Hackman - Gertjan Hofman - Paul Knowles - Exaos Lee - Rudi Meier - Glenn Moloney - Dave Morris - John M O'Donnell - Konstantin Olchanski - Renee Poutissou - Tamsen Schurman - Andreas Suter - Jan M.Wouters - Piotr Adam Zolnierczuk