Program Listing for File pvAlarm.cpp

Return to documentation for file (src/property/pvAlarm.cpp)

/* pvAlarm.cpp */
/*
 * Copyright information and license terms for this software can be
 * found in the file LICENSE that is included with the distribution
 */
#include <string>
#include <stdexcept>

#define epicsExportSharedSymbols
#include <pv/pvType.h>
#include <pv/pvIntrospect.h>
#include <pv/pvData.h>
#include <pv/pvAlarm.h>

using std::tr1::static_pointer_cast;
using std::string;

namespace epics { namespace pvData {

string PVAlarm::noAlarmFound("No alarm structure found");
string PVAlarm::notAttached("Not attached to an alarm structure");

bool PVAlarm::attach(PVFieldPtr const & pvField)
{
    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 PVAlarm::detach()
{
    pvSeverity.reset();
    pvStatus.reset();
    pvMessage.reset();
}

bool PVAlarm::isAttached()
{
    if(pvSeverity.get()==NULL) return false;
    return true;
}

void PVAlarm::get(Alarm & alarm) const
{
    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 PVAlarm::set(Alarm const & alarm)
{
    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;
}

}}