Class Alarm

Class Documentation

class Alarm

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.

Public Functions

inline Alarm()

Constructor

inline std::string getMessage() const

get the current message.

Returns

The message.

inline void setMessage(std::string const &value)

set the current message.

Parameters

value – The new message value.

AlarmSeverity getSeverity() const

get the current severity.

Returns

The severity.

inline void setSeverity(AlarmSeverity value)

set the current severity.

Parameters

value – The new severity.

Throws

if – severity value is out of range.

AlarmStatus getStatus() const

get the current status.

Returns

The status.

inline void setStatus(AlarmStatus value)

set the current status.

Parameters

value – The new status.

Throws

if – status value is out of range.