epics::pvDatabase::ControlSupport Class Reference

Base interface for a ControlSupport. More...

#include "controlSupport.h"

Inheritance diagram for epics::pvDatabase::ControlSupport:

Collaboration diagram for epics::pvDatabase::ControlSupport:

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

Static Public Member Functions
static ControlSupportPtr	create (PVRecordPtr const &pvRecord)
	create a ControlSupport More...
static epics::pvData::StructureConstPtr	controlField (epics::pvData::ScalarType scalarType)
	create a controlSupport required by ControlSupport More...

Detailed Description

Base interface for a ControlSupport.

Definition at line 28 of file controlSupport.h.

Constructor & Destructor Documentation

epics::pvDatabase::ControlSupport::~ControlSupport ( )

virtual

The Destructor.

Definition at line 30 of file controlSupport.cpp.

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

Member Function Documentation

epics::pvData::StructureConstPtr epics::pvDatabase::ControlSupport::controlField ( epics::pvData::ScalarType  scalarType )

static

create a controlSupport required by ControlSupport

Parameters

scalarType

The type for outputValue.

Returns

The controlField introspection structure.

Definition at line 35 of file controlSupport.cpp.

{
    return FieldBuilder::begin()
            ->setId("control_t")
            ->add("limitLow", pvDouble)
            ->add("limitHigh", pvDouble)
            ->add("minStep", pvDouble)
            ->add("outputValue", scalarType)
            ->createStructure();
}

ControlSupportPtr epics::pvDatabase::ControlSupport::create ( PVRecordPtr const &  pvRecord )

static

create a ControlSupport

Parameters

pvRecord

- The pvRecord to which the support is attached.

Returns

The new ControlSupport

Definition at line 47 of file controlSupport.cpp.

{
   ControlSupportPtr support(new ControlSupport(pvRecord));
   return support;
}

bool epics::pvDatabase::ControlSupport::init ( epics::pvData::PVFieldPtr const &  pvValue, epics::pvData::PVFieldPtr const &  pvSupport  )

virtual

Connects to contol fields.

Parameters

pvValue	The field to support.
pvSupport	Support specific fields.

Returns

true for success and false for failure.

Reimplemented from epics::pvDatabase::PVSupport.

Definition at line 57 of file controlSupport.cpp.

{
    if(pv) {
         if(pv->getField()->getType()==epics::pvData::scalar) {
              ScalarConstPtr s = static_pointer_cast<const Scalar>(pv->getField());
              if(ScalarTypeFunc::isNumeric(s->getScalarType())) {
                   pvValue = static_pointer_cast<PVScalar>(pv);
              }
         }
    }
    if(!pvValue) {
        cout << "ControlSupport for record " << pvRecord->getRecordName()
        << " failed because not numeric scalar\n";
        return false;
    }
    pvControl = static_pointer_cast<PVStructure>(pvsup);
    if(pvControl) {
       pvLimitLow = pvControl->getSubField<PVDouble>("limitLow");
       pvLimitHigh = pvControl->getSubField<PVDouble>("limitHigh");
       pvMinStep = pvControl->getSubField<PVDouble>("minStep");
       pvOutputValue = pvControl->getSubField<PVScalar>("outputValue");
    }
    if(!pvControl || !pvLimitLow || !pvLimitHigh || !pvMinStep || !pvOutputValue) {
        cout << "ControlSupport for record " << pvRecord->getRecordName()
        << " failed because pvSupport not a valid control structure\n";
        return false;
    }
    ConvertPtr convert = getConvert();
    currentValue = convert->toDouble(pvValue);
    isMinStep = false;
    return true;
}

epics::pvDatabase::ControlSupport::POINTER_DEFINITIONS

(

ControlSupport

)

bool epics::pvDatabase::ControlSupport::process ( )

virtual

Honors control fields.

Returns

Returns true is any fields were modified; otherwise false.

Implements epics::pvDatabase::PVSupport.

Definition at line 90 of file controlSupport.cpp.

{
    ConvertPtr convert = getConvert();
    double value = convert->toDouble(pvValue);
    if(!isMinStep && value==currentValue) return false;
    double limitLow = pvLimitLow->get();
    double limitHigh = pvLimitHigh->get();
    double minStep = pvMinStep->get();
    bool setValue = false;
    if(limitHigh>limitLow) {
        if(value>limitHigh) {value = limitHigh;setValue=true;}
        if(value<limitLow) {value = limitLow;setValue=true;}
    }
    if(setValue) convert->fromDouble(pvValue,value);
    double diff = value - currentValue;
    double outputValue = value;
    if(minStep>0.0) {
        if(diff<0.0) {
            outputValue = currentValue - minStep;
            if(limitHigh>limitLow && outputValue<=limitLow) outputValue = limitLow;
            isMinStep = true;
            if(outputValue<value) {
                 outputValue = value;
                 isMinStep = false;
            }
        } else {
            outputValue = currentValue + minStep;
            if(limitHigh>limitLow && outputValue>=limitHigh) outputValue = limitHigh;
            isMinStep = true;
            if(outputValue>value)  {
                 outputValue = value;
                 isMinStep = false;
            }
        }
    }
    if(outputValue==currentValue) return false;
    currentValue = outputValue;
    convert->fromDouble(pvOutputValue,outputValue);
    return true;
}

void epics::pvDatabase::ControlSupport::reset ( )

virtual

If implementing minSteps it sets isMinStep to false.

Returns

Returns true is any fields were modified; otherwise false.

Reimplemented from epics::pvDatabase::PVSupport.

Definition at line 131 of file controlSupport.cpp.

{
   isMinStep = false;
}

---

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

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