epics::pvDatabase::ScalarAlarmSupport Class Reference

Base interface for a ScalarAlarmSupport. More...

#include "scalarAlarmSupport.h"

Inheritance diagram for epics::pvDatabase::ScalarAlarmSupport:

Collaboration diagram for epics::pvDatabase::ScalarAlarmSupport:

Public Member Functions
	POINTER_DEFINITIONS (ScalarAlarmSupport)
virtual	~ScalarAlarmSupport ()
virtual bool	init (epics::pvData::PVFieldPtr const &pvValue, epics::pvData::PVStructurePtr const &pvAlarm, epics::pvData::PVFieldPtr const &pvSupport)
	Connects to contol fields. More...
virtual bool	process ()
	Honors scalarAlarm fields. More...
virtual void	reset ()
	If implementing minSteps it sets isMinStep to false. More...

Static Public Member Functions
static ScalarAlarmSupportPtr	create (PVRecordPtr const &pvRecord)
	create a ScalarAlarm More...
static epics::pvData::StructureConstPtr	scalarAlarmField ()
	create a scalarAlarm required by ScalarAlarm More...

Detailed Description

Base interface for a ScalarAlarmSupport.

Definition at line 31 of file scalarAlarmSupport.h.

Constructor & Destructor Documentation

epics::pvDatabase::ScalarAlarmSupport::~ScalarAlarmSupport ( )

virtual

The Destructor.

Definition at line 31 of file scalarAlarmSupport.cpp.

{
//cout << "ScalarAlarmSupport::~ScalarAlarmSupport()\n";
}

Member Function Documentation

ScalarAlarmSupportPtr epics::pvDatabase::ScalarAlarmSupport::create ( PVRecordPtr const &  pvRecord )

static

create a ScalarAlarm

Parameters

pvRecord

- The pvRecord to which the support is attached.

Returns

The new ScalarAlarm

Definition at line 49 of file scalarAlarmSupport.cpp.

{
   ScalarAlarmSupportPtr support(new ScalarAlarmSupport(pvRecord));
   return support;
}

bool epics::pvDatabase::ScalarAlarmSupport::init ( epics::pvData::PVFieldPtr const &  pvValue, epics::pvData::PVStructurePtr const &  pvAlarm, epics::pvData::PVFieldPtr const &  pvSupport  )

virtual

Connects to contol fields.

Parameters

pvValue	The field to support.
pvAlarm	The alarm field.
pvSupport	Support specific fields.

Returns

true for success and false for failure.

Definition at line 61 of file scalarAlarmSupport.cpp.

{
    if(pvval->getField()->getType()==epics::pvData::scalar) {
        ScalarConstPtr s = static_pointer_cast<const Scalar>(pvval->getField());
        if(ScalarTypeFunc::isNumeric(s->getScalarType())) {
            pvValue = static_pointer_cast<PVScalar>(pvval);
        }
    }
    if(!pvValue) {
        cout << "ScalarAlarmSupport for record " << pvRecord->getRecordName()
        << " failed because not numeric scalar\n";
        return false;
    }
    pvScalarAlarm = static_pointer_cast<PVStructure>(pvsup);
    if(pvScalarAlarm) {
       pvLowAlarmLimit = pvScalarAlarm->getSubField<PVDouble>("lowAlarmLimit");
       pvLowWarningLimit = pvScalarAlarm->getSubField<PVDouble>("lowWarningLimit");
       pvHighWarningLimit = pvScalarAlarm->getSubField<PVDouble>("highWarningLimit");
       pvHighAlarmLimit = pvScalarAlarm->getSubField<PVDouble>("highAlarmLimit");
       pvHysteresis = pvScalarAlarm->getSubField<PVDouble>("hysteresis");
    }
    if(!pvScalarAlarm
       || !pvLowAlarmLimit || !pvLowWarningLimit
       || !pvLowWarningLimit || !pvHighAlarmLimit
       || !pvHysteresis)
    {
        cout << "ScalarAlarmSupport for record " << pvRecord->getRecordName()
        << " failed because pvSupport not a valid scalarAlarm structure\n";
        return false;
    }
    pvAlarm = pvalarm;
    ConvertPtr convert = getConvert();
    requestedValue = convert->toDouble(pvValue);
    currentValue = requestedValue;
    isHystersis = false;
    setAlarm(pvAlarm,range_Undefined);
    return true;
}

epics::pvDatabase::ScalarAlarmSupport::POINTER_DEFINITIONS

(

ScalarAlarmSupport

)

bool epics::pvDatabase::ScalarAlarmSupport::process ( )

virtual

Honors scalarAlarm fields.

Returns

Returns true is any fields were modified; otherwise false.

Implements epics::pvDatabase::PVSupport.

Definition at line 103 of file scalarAlarmSupport.cpp.

{
    ConvertPtr convert = getConvert();
    double value = convert->toDouble(pvValue);
    double lowAlarmLimit = pvLowAlarmLimit->get();
    double lowWarningLimit = pvLowWarningLimit->get();
    double highWarningLimit = pvHighWarningLimit->get();
    double highAlarmLimit = pvHighAlarmLimit->get();
    double hysteresis = pvHysteresis->get();
    int alarmRange = range_Normal;
    if(highAlarmLimit>lowAlarmLimit) {
         if(value>=highAlarmLimit
         ||(prevAlarmRange==range_Hihi && value>=highAlarmLimit-hysteresis)) {
             alarmRange = range_Hihi;
         } else if(value<=lowAlarmLimit
         ||(prevAlarmRange==range_Lolo && value<=lowAlarmLimit+hysteresis)) {
             alarmRange = range_Lolo;
         }
    }
    if(alarmRange==range_Normal && (highWarningLimit>lowWarningLimit)) {
         if(value>=highWarningLimit
         ||(prevAlarmRange==range_High && value>=highWarningLimit-hysteresis)) {
             alarmRange = range_High;
         } else if(value<=lowWarningLimit
         ||(prevAlarmRange==range_Low && value<=lowWarningLimit+hysteresis)) {
             alarmRange = range_Low;
         }
    }
    bool retValue = false;
    if(alarmRange!=prevAlarmRange) {
        setAlarm(pvAlarm,alarmRange);
        retValue = true;
    }
    prevAlarmRange = alarmRange;
    currentValue = value;
    return retValue;
}

void epics::pvDatabase::ScalarAlarmSupport::reset ( )

virtual

If implementing minSteps it sets isMinStep to false.

Reimplemented from epics::pvDatabase::PVSupport.

Definition at line 141 of file scalarAlarmSupport.cpp.

{
   isHystersis = false;
}

epics::pvData::StructureConstPtr epics::pvDatabase::ScalarAlarmSupport::scalarAlarmField ( )

static

create a scalarAlarm required by ScalarAlarm

Returns

The scalarAlarmField introspection structure.

Definition at line 37 of file scalarAlarmSupport.cpp.

{
    return FieldBuilder::begin()
            ->setId("scalarAlarm_t")
            ->add("lowAlarmLimit", pvDouble)
            ->add("lowWarningLimit", pvDouble)
            ->add("highWarningLimit", pvDouble)
            ->add("highAlarmLimit", pvDouble)
            ->add("hysteresis", pvDouble)
            ->createStructure();
}

---

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

• modules/pvDatabase/src/pv/scalarAlarmSupport.h
• modules/pvDatabase/src/support/scalarAlarmSupport.cpp