epics::pvCopy::PVDeadbandFilter Class Reference

A Plugin for a filter that gets a sub array from a PVScalarDeadband. More...

#include "pvDeadbandPlugin.h"

Inheritance diagram for epics::pvCopy::PVDeadbandFilter:

Collaboration diagram for epics::pvCopy::PVDeadbandFilter:

Public Member Functions
	POINTER_DEFINITIONS (PVDeadbandFilter)
virtual	~PVDeadbandFilter ()
bool	filter (const epics::pvData::PVFieldPtr &pvCopy, const epics::pvData::BitSetPtr &bitSet, bool toCopy)
std::string	getName ()
Public Member Functions inherited from epics::pvCopy::PVFilter
	POINTER_DEFINITIONS (PVFilter)
virtual	~PVFilter ()

Static Public Member Functions
static PVDeadbandFilterPtr	create (const std::string &requestValue, const epics::pvData::PVFieldPtr &master)

Detailed Description

A Plugin for a filter that gets a sub array from a PVScalarDeadband.

Definition at line 61 of file pvDeadbandPlugin.h.

Constructor & Destructor Documentation

epics::pvCopy::PVDeadbandFilter::~PVDeadbandFilter ( )

virtual

Definition at line 56 of file pvDeadbandPlugin.cpp.

{
}

Member Function Documentation

PVDeadbandFilterPtr epics::pvCopy::PVDeadbandFilter::create ( const std::string &  requestValue, const epics::pvData::PVFieldPtr &  master  )

static

Create a PVDeadbandFilter.

Parameters

requestValue	The value part of a name=value request option.
master	The field in the master PVStructure to which the PVFilter will be attached.

Returns

The PVFilter. A null is returned if master or requestValue is not appropriate for the plugin.

Definition at line 60 of file pvDeadbandPlugin.cpp.

{
    FieldConstPtr field =master->getField();
    Type type = field->getType();
    if(type!=scalar) return PVDeadbandFilterPtr();
    ScalarConstPtr scalar = static_pointer_cast<const Scalar>(field);
    if(!ScalarTypeFunc::isNumeric(scalar->getScalarType())) return PVDeadbandFilterPtr();
    bool absolute = false;
    if(requestValue.find("abs")==0) {
        absolute = true;
    } else if(requestValue.find("rel")==0) {
        absolute = false;
    } else {
        return PVDeadbandFilterPtr();
    }
    size_t ind = requestValue.find(':');
    if(ind==string::npos) return PVDeadbandFilterPtr();
    string svalue = requestValue.substr(ind+1);
    double deadband = atof(svalue.c_str());
    if(deadband==0.0) return PVDeadbandFilterPtr();
    PVDeadbandFilterPtr filter =
         PVDeadbandFilterPtr(
             new PVDeadbandFilter(
                 absolute,deadband,static_pointer_cast<PVScalar>(master)));
    return filter;
}

bool epics::pvCopy::PVDeadbandFilter::filter ( const epics::pvData::PVFieldPtr &  pvCopy, const epics::pvData::BitSetPtr &  bitSet, bool  toCopy  )

virtual

Perform a filter operation

Parameters

pvCopy	The field in the copy PVStructure.
bitSet	A bitSet for copyPVStructure.
toCopy	(true,false) means copy (from master to copy,from copy to master)

Returns

if filter (modified, did not modify) destination. Null is returned if master or requestValue is not appropriate for the plugin.

Implements epics::pvCopy::PVFilter.

Definition at line 99 of file pvDeadbandPlugin.cpp.

{
    if(!toCopy) return false;
    double value = convert->toDouble(master);
    double diff = value - lastReportedValue;
    if(diff<0.0) diff = - diff;
    bool report = true;
    if(firstTime) {
        firstTime = false;
    } else if(absolute) {
        if(diff<deadband) report = false;
    } else {
        double last = lastReportedValue;
        if(last<0.0) last = -last;
        if(last>1e-20) {
            double percent = (diff/last)*100.0;
            if(percent<deadband) report = false;
         }
     }
     PVScalarPtr copy = static_pointer_cast<PVScalar>(pvCopy);
     convert->fromDouble(copy,value);
     if(report) {
         lastReportedValue = value;
         bitSet->set(pvCopy->getFieldOffset());
     } else {
         bitSet->clear(pvCopy->getFieldOffset());
     }
     return true;
}

string epics::pvCopy::PVDeadbandFilter::getName ( )

virtual

Get the filter name.

Returns

The name.

Implements epics::pvCopy::PVFilter.

Definition at line 129 of file pvDeadbandPlugin.cpp.

{
    return name;
}

epics::pvCopy::PVDeadbandFilter::POINTER_DEFINITIONS

(

PVDeadbandFilter

)

---

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

• modules/pvDatabase/src/pv/pvDeadbandPlugin.h
• modules/pvDatabase/src/copy/pvDeadbandPlugin.cpp