Skip to content

Midas C++ API - al_xxx functions

This page contains the full API reference for the al_xxx alarm functions.

For the concepts and day-to-day use, see Alarms: overview.

For explanations and examples of working with alarms from code, see Alarms: programming.

Midas Alarm Functions (al_xxx)

Functions

al_check 

INT al_check()

Scan ODB for alarms.

Returns:

Declared in include/midas.h:2112, defined in src/alarm.cxx:695

al_define_odb_alarm 

INT al_define_odb_alarm(const char *name, const char *condition, const char *aclass, const char *message)

Create an alarm that will trigger when an ODB condition is met.

Parameters:

  • name (const char *) –
    Alarm name, defined in /alarms/alarms
  • condition (const char *) –
    Alarm condition to be evaluated
  • aclass (const char *)
  • message (const char *) –
    Alarm message
  • class –
    Alarm class to be triggered

Returns:

Declared in include/midas.h:2119, defined in src/alarm.cxx:1004

al_get_alarms 

INT al_get_alarms(std::string *presult)

Scan ODB for alarms.

Returns:

Declared in include/midas.h:2118, defined in src/alarm.cxx:927

al_reset_alarm 

INT al_reset_alarm(const char *alarm_name)

Reset (acknoledge) alarm.

Parameters:

  • alarm_name (const char *) –
    Alarm name, defined in /alarms/alarms

Returns:

Declared in include/midas.h:2116, defined in src/alarm.cxx:605

al_trigger_alarm 

INT al_trigger_alarm(const char *alarm_name, const char *alarm_message, const char *default_class, const 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 (const char *) –
    Alarm name, defined in /alarms/alarms
  • alarm_message (const char *) –
    Optional message which goes with alarm
  • default_class (const char *) –
    If alarm is not yet defined under /alarms/alarms/\<alarm_name>, a new one is created and this default class is used.
  • cond_str (const char *) –
    String displayed in alarm condition
  • type (INT) –
    Alarm type, one of AT_xxx

Returns:

Declared in include/midas.h:2113, defined in src/alarm.cxx:396