pvDatabaseCPP  4.7.0
Public Member Functions | Static Public Member Functions | List of all members
epics::pvCopy::PVArrayFilter Class Reference

A filter that gets a sub array from a PVScalarArray. More...

#include <pvArrayPlugin.h>

Inheritance diagram for epics::pvCopy::PVArrayFilter:
epics::pvCopy::PVFilter

Public Member Functions

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

Static Public Member Functions

static PVArrayFilterPtr create (const std::string &requestValue, const epics::pvData::PVFieldPtr &master)
 

Detailed Description

A filter that gets a sub array from a PVScalarArray.

Definition at line 60 of file pvArrayPlugin.h.

Constructor & Destructor Documentation

◆ ~PVArrayFilter()

epics::pvCopy::PVArrayFilter::~PVArrayFilter ( )
virtual

Definition at line 53 of file pvArrayPlugin.cpp.

Member Function Documentation

◆ create()

PVArrayFilterPtr epics::pvCopy::PVArrayFilter::create ( const std::string &  requestValue,
const epics::pvData::PVFieldPtr &  master 
)
static

Create a PVArrayFilter.

Parameters
requestValueThe value part of a name=value request option.
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.

Definition at line 77 of file pvArrayPlugin.cpp.

◆ filter()

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

Perform a filter operation

Parameters
pvCopyThe field in the copy PVStructure.
bitSetA 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 150 of file pvArrayPlugin.cpp.

◆ getName()

string epics::pvCopy::PVArrayFilter::getName ( )
virtual

Get the filter name.

Returns
The name.

Implements epics::pvCopy::PVFilter.

Definition at line 220 of file pvArrayPlugin.cpp.

◆ POINTER_DEFINITIONS() [1/2]

epics::pvCopy::PVFilter::POINTER_DEFINITIONS ( PVFilter  )
inherited

◆ POINTER_DEFINITIONS() [2/2]

epics::pvCopy::PVArrayFilter::POINTER_DEFINITIONS ( PVArrayFilter  )

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