ngcbALARM.hpp

Go to the documentation of this file.

#ifndef ngcbALARM_H
#define ngcbALARM_H
 
 
#ifndef __cplusplus
#error This is a C++ include file and cannot be used from plain C
#endif
 
/* 
 * System Headers 
 */
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <errno.h>
 
/*
 * Local Headers 
 */
#include <ngc/core/ngcbLIST.hpp>
 
/*
 * Alarm severity levels
 */
#define ngcbALARM_NO_ALARM     0x00  //< no alarm
#define ngcbALARM_WARNING      0x01  //< warning
#define ngcbALARM_FATAL        0x02  //< fatal
#define ngcbALARM_ACK          0x10  //< acknowledge bit mask
#define ngcbALARM_INT          0x20  //< alarm for integer value 
#define ngcbALARM_DOUBLE       0x40  //< alarm for double value
#define ngcbALARM_WARNING_ACK (ngcbALARM_WARNING|ngcbALARM_ACK) //< warning ack
#define ngcbALARM_FATAL_ACK   (ngcbALARM_FATAL|ngcbALARM_ACK)   //< fatal ack

#define ngcbALARM_MASK (ngcbALARM_WARNING|ngcbALARM_FATAL|ngcbALARM_ACK)

typedef unsigned long int ngcb_alarm_id;

class ngcbALARM;

class ngcbALARM_SYS
{
public:
  ngcbALARM_SYS();
  
  virtual ~ngcbALARM_SYS();

  virtual ngcb_alarm_id Issue(ngcbALARM *alarm);
  
  virtual void Cancel(ngcb_alarm_id id);

  virtual void Ack(ngcb_alarm_id id);

  void Store(ngcbALARM *alarm, ngcb_alarm_id id);

  void Remove(ngcb_alarm_id id);

  ngcbALARM *Get(ngcb_alarm_id id);
  
  void PrintList(FILE *s);
 
protected:
private:
  ngcbLIST alarmList_;
};

class ngcbALARM
{
public:
  ngcbALARM &operator=(const ngcbALARM &other); 

  ngcbALARM(const ngcbALARM &other); 

  ngcbALARM();
  
  ngcbALARM(ngcbALARM_SYS *sys, const char *name, int level, const char *msg);

  ngcbALARM(ngcbALARM_SYS *sys, const char *name, int level, const char *msg,
        int value, const char *unit = NULL);

  ngcbALARM(ngcbALARM_SYS *sys, const char *name, int level, const char *msg,
        double value, const char *unit = NULL); 

  virtual ~ngcbALARM(); 
  
  ngcb_alarm_id Id();

  const char *Name();

  int Level();

  const char *Msg();

  const char *Format();

  const char *Unit();

  const char *Value(int showUnit); 
  
  int AckPending();

  void Ack();
 
protected:
 
private:
  int level_;

  char name_[32];

  char msg_[256];
  
  char format_[8];

  char unit_[8];

  char value_[64];

  int *ival_;

  double *dval_;

  ngcbALARM_SYS *sys_;

  ngcb_alarm_id id_;

  void Init_(const char *name, int level, const char *msg);

  void Issue_(); 
};
 
#endif