epics::pvData::Alarm Class Reference

Methods for manipulating alarm. More...

#include "alarm.h"

Public Member Functions
	Alarm ()
std::string	getMessage () const
void	setMessage (std::string const &value)
AlarmSeverity	getSeverity () const
void	setSeverity (AlarmSeverity value)
AlarmStatus	getStatus () const
void	setStatus (AlarmStatus value)

Detailed Description

Methods for manipulating alarm.

An alarm structure has the following fields:

structure
    int severity
    int status
    string message

This is a class that holds values corresponding to the fields in an alarm structure. It is meant to be used together with pvAlarm which allows values to be copied between an alarm structure and this class. This class should not be extended.

Definition at line 105 of file alarm.h.

Constructor & Destructor Documentation

epics::pvData::Alarm::Alarm ( )

inline

Constructor

Definition at line 110 of file alarm.h.

: severity(0),status(0), message(std::string("")) {}

Member Function Documentation

std::string epics::pvData::Alarm::getMessage ( ) const

inline

get the current message.

Returns

The message.

Definition at line 116 of file alarm.h.

{return message;}

AlarmSeverity epics::pvData::Alarm::getSeverity

(

)

const

get the current severity.

Returns

The severity.

Definition at line 58 of file alarm.cpp.

{
    switch(severity) {
    case 0: return noAlarm;
    case 1: return minorAlarm;
    case 2: return majorAlarm;
    case 3: return invalidAlarm;
    case 4: return undefinedAlarm;
    }
    throw std::logic_error(string("should never get here"));
}

AlarmStatus epics::pvData::Alarm::getStatus

(

)

const

get the current status.

Returns

The status.

Definition at line 109 of file alarm.cpp.

{
    switch(status) {
    case 0: return noStatus;
    case 1: return deviceStatus;
    case 2: return driverStatus;
    case 3: return recordStatus;
    case 4: return dbStatus;
    case 5: return confStatus;
    case 6: return undefinedStatus;
    case 7: return clientStatus;
    }
    throw std::logic_error(string("should never get here"));
}

void epics::pvData::Alarm::setMessage ( std::string const &  value )

inline

set the current message.

Parameters

value

The new message value.

Definition at line 121 of file alarm.h.

{message = value;}

void epics::pvData::Alarm::setSeverity ( AlarmSeverity  value )

inline

set the current severity.

Parameters

value

The new severity.

Exceptions

if	severity value is out of range.

Definition at line 132 of file alarm.h.

{severity = value;}

void epics::pvData::Alarm::setStatus ( AlarmStatus  value )

inline

set the current status.

Parameters

value

The new status.

Exceptions

if	status value is out of range.

Definition at line 143 of file alarm.h.

{ status = value;}

---

The documentation for this class was generated from the following files:

• modules/pvData/src/property/pv/alarm.h
• modules/pvData/src/property/alarm.cpp