This is Unofficial EPICS BASE Doxygen Site
epics::pvCopy::PVPlugin Class Referenceabstract

A filter plugin that attaches to a field of a PVStrcture. More...

#include "pvPlugin.h"

+ Inheritance diagram for epics::pvCopy::PVPlugin:

Public Member Functions

 POINTER_DEFINITIONS (PVPlugin)
 
virtual ~PVPlugin ()
 
virtual PVFilterPtr create (const std::string &requestValue, const PVCopyPtr &pvCopy, const epics::pvData::PVFieldPtr &master)=0
 

Detailed Description

A filter plugin that attaches to a field of a PVStrcture.

PVCopy looks for plugins defined in pvRequest and calls the filter when a pvCopy is updated.

Author
mrk
Since
2017.03.17

Interface for a filter plugin for PVCopy.

Definition at line 44 of file pvPlugin.h.

Constructor & Destructor Documentation

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

Definition at line 47 of file pvPlugin.h.

47 {}

Member Function Documentation

virtual PVFilterPtr epics::pvCopy::PVPlugin::create ( const std::string &  requestValue,
const PVCopyPtr pvCopy,
const epics::pvData::PVFieldPtr master 
)
pure virtual

Create a PVFilter.

Parameters
requestValueThe value part of a name=value request option.
pvCopyThe PVCopy to which the PVFilter will be attached.
masterThe 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.

Implemented in epics::pvCopy::PVDeadbandPlugin, epics::pvCopy::PVTimestampPlugin, and epics::pvCopy::PVArrayPlugin.

epics::pvCopy::PVPlugin::POINTER_DEFINITIONS ( PVPlugin  )

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