Class PVAlarm¶

Defined in File pvAlarm.h

Class Documentation¶

class PVAlarm¶

Methods for accessing an alarm structure.

An alarm structure has the following fields:

structure
    int severity
    int status
    string message

This class can be attached to an alarm structure field of any PVData object. The methods provide access to the fields in the attached structure, via an instance of class Alarm. This class should not be extended.

Public Functions

inline PVAlarm()¶: Constructor

bool attach(PVFieldPtr const &pvField)¶

void detach()¶: Detach for pvField.

bool isAttached()¶

Is the PVAlarm attached to a pvField?

Returns: (false,true) (is not,is) attached to a pvField.

void get(Alarm &alarm) const¶

copy the alarm structure values to Alarm

Parameters: alarm – An instance of class Alarm
Throws: If – not attached to a pvField.

bool set(Alarm const &alarm)¶

copy the values from Alarm to the alarm structure.

Parameters: alarm – An instance of class Alarm
Throws: If – not attached to a pvField.
Returns: (false,true) if pvField (immutable, mutable)