This is Unofficial EPICS BASE Doxygen Site
Public Member Functions | List of all members
epics::pvCopy::PVFilter Class Referenceabstract

A Filter that is called when a copy PVStructure is being updated. More...

#include "pvPlugin.h"

+ Inheritance diagram for epics::pvCopy::PVFilter:

Public Member Functions

 POINTER_DEFINITIONS (PVFilter)
 
virtual ~PVFilter ()
 
virtual bool filter (const epics::pvData::PVFieldPtr &copy, const epics::pvData::BitSetPtr &bitSet, bool toCopy)=0
 
virtual std::string getName ()=0
 

Detailed Description

A Filter that is called when a copy PVStructure is being updated.

This interface defines a filter to update a copy of a field from a master PVStructure. of the data in the master.

Definition at line 68 of file pvPlugin.h.

Constructor & Destructor Documentation

virtual epics::pvCopy::PVFilter::~PVFilter ( )
inlinevirtual

Definition at line 71 of file pvPlugin.h.

71 {}

Member Function Documentation

virtual bool epics::pvCopy::PVFilter::filter ( const epics::pvData::PVFieldPtr &  copy,
const epics::pvData::BitSetPtr &  bitSet,
bool  toCopy 
)
pure virtual

Update copy or master.

Parameters
copyThe data for copy.
bitSetThe BitSet for copy.
toCopy(true,false) means copy (from master to copy,from copy to master)
Returns
(true,false) if filter modified destination.

Implemented in epics::pvCopy::PVDeadbandFilter, epics::pvCopy::PVArrayFilter, and epics::pvCopy::PVTimestampFilter.

virtual std::string epics::pvCopy::PVFilter::getName ( )
pure virtual

Get the filter name. This is the name part of a request name=value pair.

Returns
The name.

Implemented in epics::pvCopy::PVDeadbandFilter, epics::pvCopy::PVArrayFilter, and epics::pvCopy::PVTimestampFilter.

epics::pvCopy::PVFilter::POINTER_DEFINITIONS ( PVFilter  )
The documentation for this class was generated from the following file: