epics::pvData::PVAlarm Class Reference

Methods for accessing an alarm structure. More...

#include "pvAlarm.h"

Public Member Functions
	PVAlarm ()
bool	attach (PVFieldPtr const &pvField)
void	detach ()
bool	isAttached ()
void	get (Alarm &alarm) const
bool	set (Alarm const &alarm)

Detailed Description

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.

Definition at line 37 of file pvAlarm.h.

Constructor & Destructor Documentation

epics::pvData::PVAlarm::PVAlarm ( )

inline

Constructor

Definition at line 43 of file pvAlarm.h.

{}

Member Function Documentation

bool epics::pvData::PVAlarm::attach

(

PVFieldPtr const &

pvField

)

Definition at line 26 of file pvAlarm.cpp.

{
    if(pvField->getField()->getType()!=structure) return false;
    PVStructurePtr pvStructure = static_pointer_cast<PVStructure>(pvField);
    pvSeverity = pvStructure->getSubField<PVInt>("severity");
    if(pvSeverity.get()==NULL) return false;
    pvStatus = pvStructure->getSubField<PVInt>("status");
    if(pvStatus.get()==NULL) {
        pvSeverity.reset();
        return false;
    }
    pvMessage = pvStructure->getSubField<PVString>("message");
    if(pvMessage.get()==NULL) {
        pvSeverity.reset();
        pvStatus.reset();
        return false;
    }
    return true;
}

void epics::pvData::PVAlarm::detach

(

)

Detach for pvField.

Definition at line 46 of file pvAlarm.cpp.

{
    pvSeverity.reset();
    pvStatus.reset();
    pvMessage.reset();
}

void epics::pvData::PVAlarm::get

(

Alarm &

alarm

)

const

copy the alarm structure values to Alarm

Parameters

alarm

An instance of class Alarm

Exceptions

If	not attached to a pvField.

Definition at line 59 of file pvAlarm.cpp.

{
    if(pvSeverity.get()==NULL) {
        throw std::logic_error(notAttached);
    }
    alarm.setSeverity(AlarmSeverityFunc::getSeverity(pvSeverity->get()));
    alarm.setStatus(AlarmStatusFunc::getStatus(pvStatus->get()));
    alarm.setMessage(pvMessage->get());
}

bool epics::pvData::PVAlarm::isAttached

(

)

Is the PVAlarm attached to a pvField?

Returns

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

Definition at line 53 of file pvAlarm.cpp.

{
    if(pvSeverity.get()==NULL) return false;
    return true;
}

bool epics::pvData::PVAlarm::set

(

Alarm const &

alarm

)

copy the values from Alarm to the alarm structure.

Parameters

alarm

An instance of class Alarm

Returns

(false,true) if pvField (immutable, mutable)

Exceptions

If	not attached to a pvField.

Definition at line 69 of file pvAlarm.cpp.

{
    if(pvSeverity.get()==NULL) {
        throw std::logic_error(notAttached);
    }
    if(pvSeverity->isImmutable() || pvMessage->isImmutable()) return false;
    Alarm current;
    get(current);
    bool returnValue = false;
    if(current.getSeverity()!=alarm.getSeverity())
    {
        pvSeverity->put(alarm.getSeverity());
        returnValue = true;
    }
    if(current.getStatus()!=alarm.getStatus())
    {
        pvStatus->put(alarm.getStatus());
        returnValue = true;
    }
    if(current.getMessage()!=alarm.getMessage())
    {
        pvMessage->put(alarm.getMessage());
        returnValue = true;
    }
    return returnValue;
}

---

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

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