alarm.h File Reference

#include "libComAPI.h"

Include dependency graph for alarm.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	NO_ALARM   0
	The NO_ALARM value can be used as both a severity and a status. More...
Original macros for alarm severity values
#define	firstEpicsAlarmSev   epicsSevNone
#define	MINOR_ALARM   epicsSevMinor
#define	MAJOR_ALARM   epicsSevMajor
#define	INVALID_ALARM   epicsSevInvalid
#define	lastEpicsAlarmSev   epicsSevInvalid
Original macros for alarm status/condition values
#define	firstEpicsAlarmCond   epicsAlarmNone
#define	READ_ALARM   epicsAlarmRead
#define	WRITE_ALARM   epicsAlarmWrite
#define	HIHI_ALARM   epicsAlarmHiHi
#define	HIGH_ALARM   epicsAlarmHigh
#define	LOLO_ALARM   epicsAlarmLoLo
#define	LOW_ALARM   epicsAlarmLow
#define	STATE_ALARM   epicsAlarmState
#define	COS_ALARM   epicsAlarmCos
#define	COMM_ALARM   epicsAlarmComm
#define	TIMEOUT_ALARM   epicsAlarmTimeout
#define	HW_LIMIT_ALARM   epicsAlarmHwLimit
#define	CALC_ALARM   epicsAlarmCalc
#define	SCAN_ALARM   epicsAlarmScan
#define	LINK_ALARM   epicsAlarmLink
#define	SOFT_ALARM   epicsAlarmSoft
#define	BAD_SUB_ALARM   epicsAlarmBadSub
#define	UDF_ALARM   epicsAlarmUDF
#define	DISABLE_ALARM   epicsAlarmDisable
#define	SIMM_ALARM   epicsAlarmSimm
#define	READ_ACCESS_ALARM   epicsAlarmReadAccess
#define	WRITE_ACCESS_ALARM   epicsAlarmWriteAccess
#define	lastEpicsAlarmCond   epicsAlarmWriteAccess

Enumerations
enum	epicsAlarmSeverity {   epicsSevNone = NO_ALARM, epicsSevMinor, epicsSevMajor, epicsSevInvalid,   ALARM_NSEV }
	Alarm severity values. More...
enum	epicsAlarmCondition {   epicsAlarmNone = NO_ALARM, epicsAlarmRead, epicsAlarmWrite, epicsAlarmHiHi,   epicsAlarmHigh, epicsAlarmLoLo, epicsAlarmLow, epicsAlarmState,   epicsAlarmCos, epicsAlarmComm, epicsAlarmTimeout, epicsAlarmHwLimit,   epicsAlarmCalc, epicsAlarmScan, epicsAlarmLink, epicsAlarmSoft,   epicsAlarmBadSub, epicsAlarmUDF, epicsAlarmDisable, epicsAlarmSimm,   epicsAlarmReadAccess, epicsAlarmWriteAccess, ALARM_NSTATUS }
	Alarm status/condition values. More...

Variables
LIBCOM_API const char *	epicsAlarmSeverityStrings [ALARM_NSEV]
	How to convert an alarm severity into a string. More...
LIBCOM_API const char *	epicsAlarmConditionStrings [ALARM_NSTATUS]
	How to convert an alarm condition/status into a string. More...

Macro Definition Documentation

#define BAD_SUB_ALARM   epicsAlarmBadSub

Definition at line 107 of file alarm.h.

#define CALC_ALARM   epicsAlarmCalc

Definition at line 103 of file alarm.h.

#define COMM_ALARM   epicsAlarmComm

Definition at line 100 of file alarm.h.

#define COS_ALARM   epicsAlarmCos

Definition at line 99 of file alarm.h.

#define DISABLE_ALARM   epicsAlarmDisable

Definition at line 109 of file alarm.h.

#define firstEpicsAlarmCond   epicsAlarmNone

Definition at line 91 of file alarm.h.

#define firstEpicsAlarmSev   epicsSevNone

Definition at line 50 of file alarm.h.

#define HIGH_ALARM   epicsAlarmHigh

Definition at line 95 of file alarm.h.

#define HIHI_ALARM   epicsAlarmHiHi

Definition at line 94 of file alarm.h.

#define HW_LIMIT_ALARM   epicsAlarmHwLimit

Definition at line 102 of file alarm.h.

#define INVALID_ALARM   epicsSevInvalid

Definition at line 53 of file alarm.h.

#define lastEpicsAlarmCond   epicsAlarmWriteAccess

Definition at line 113 of file alarm.h.

#define lastEpicsAlarmSev   epicsSevInvalid

Definition at line 54 of file alarm.h.

#define LINK_ALARM   epicsAlarmLink

Definition at line 105 of file alarm.h.

#define LOLO_ALARM   epicsAlarmLoLo

Definition at line 96 of file alarm.h.

#define LOW_ALARM   epicsAlarmLow

Definition at line 97 of file alarm.h.

#define MAJOR_ALARM   epicsSevMajor

Definition at line 52 of file alarm.h.

#define MINOR_ALARM   epicsSevMinor

Definition at line 51 of file alarm.h.

#define NO_ALARM   0

The NO_ALARM value can be used as both a severity and a status.

Definition at line 32 of file alarm.h.

#define READ_ACCESS_ALARM   epicsAlarmReadAccess

Definition at line 111 of file alarm.h.

#define READ_ALARM   epicsAlarmRead

Definition at line 92 of file alarm.h.

#define SCAN_ALARM   epicsAlarmScan

Definition at line 104 of file alarm.h.

#define SIMM_ALARM   epicsAlarmSimm

Definition at line 110 of file alarm.h.

#define SOFT_ALARM   epicsAlarmSoft

Definition at line 106 of file alarm.h.

#define STATE_ALARM   epicsAlarmState

Definition at line 98 of file alarm.h.

#define TIMEOUT_ALARM   epicsAlarmTimeout

Definition at line 101 of file alarm.h.

#define UDF_ALARM   epicsAlarmUDF

Definition at line 108 of file alarm.h.

#define WRITE_ACCESS_ALARM   epicsAlarmWriteAccess

Definition at line 112 of file alarm.h.

#define WRITE_ALARM   epicsAlarmWrite

Definition at line 93 of file alarm.h.

Enumeration Type Documentation

enum epicsAlarmCondition

Alarm status/condition values.

Note

These must match the choices in menuAlarmStat.dbd

Enumerator
epicsAlarmNone	No alarm
epicsAlarmRead	Read alarm (read error)
epicsAlarmWrite	Write alarm (write error)
epicsAlarmHiHi	High high limit alarm
epicsAlarmHigh	High limit alarm
epicsAlarmLoLo	Low low limit alarm
epicsAlarmLow	Low limit alarm
epicsAlarmState	State alarm (e.g. off/on)
epicsAlarmCos	Change of state alarm
epicsAlarmComm	Communication alarm
epicsAlarmTimeout	Timeout alarm
epicsAlarmHwLimit	Hardware limit alarm
epicsAlarmCalc	Calculation expression error
epicsAlarmScan	Scan alarm, e.g. record not processed (10 times) or not in desired scan list
epicsAlarmLink	Link alarm
epicsAlarmSoft	Soft alarm, e.g. in sub record if subroutine gives error
epicsAlarmBadSub	Bad subroutine alarm, e.g. in sub record subroutine not defined
epicsAlarmUDF	Undefined value alarm, e.g. record never processed
epicsAlarmDisable	Record disabled using DISV/DISA fields
epicsAlarmSimm	Record is in simulation mode
epicsAlarmReadAccess	Read access permission problem
epicsAlarmWriteAccess	Write access permission problem
ALARM_NSTATUS	Number of alarm conditions

Definition at line 61 of file alarm.h.

             {
    epicsAlarmNone = NO_ALARM, 
    epicsAlarmRead,            
    epicsAlarmWrite,           
    epicsAlarmHiHi,            
    epicsAlarmHigh,            
    epicsAlarmLoLo,            
    epicsAlarmLow,             
    epicsAlarmState,           
    epicsAlarmCos,             
    epicsAlarmComm,            
    epicsAlarmTimeout,         
    epicsAlarmHwLimit,         
    epicsAlarmCalc,            
    epicsAlarmScan,            
    epicsAlarmLink,            
    epicsAlarmSoft,            
    epicsAlarmBadSub,          
    epicsAlarmUDF,             
    epicsAlarmDisable,         
    epicsAlarmSimm,            
    epicsAlarmReadAccess,      
    epicsAlarmWriteAccess,     
    ALARM_NSTATUS              
} epicsAlarmCondition;

enum epicsAlarmSeverity

Alarm severity values.

Note

These must match the choices in menuAlarmSevr.dbd

Enumerator
epicsSevNone	No alarm
epicsSevMinor	Minor alarm severity
epicsSevMajor	Major alarm severity
epicsSevInvalid	Invalid alarm severity
ALARM_NSEV	Number of alarm severities

Definition at line 38 of file alarm.h.

             {
    epicsSevNone = NO_ALARM, 
    epicsSevMinor,           
    epicsSevMajor,           
    epicsSevInvalid,         
    ALARM_NSEV               
} epicsAlarmSeverity;

Variable Documentation

LIBCOM_API const char* epicsAlarmConditionStrings[ALARM_NSTATUS]

How to convert an alarm condition/status into a string.

Definition at line 26 of file alarmString.c.

LIBCOM_API const char* epicsAlarmSeverityStrings[ALARM_NSEV]

How to convert an alarm severity into a string.

Definition at line 16 of file alarmString.c.