epics/pvDatabase
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

copy lib now part of pvDatabase

Browse Source
This commit is contained in:
mrkraimer
2019-06-26 10:47:58 -04:00
parent f2d6e05816
commit e57348a4c5
22 changed files with 35 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
src/copy/Makefile
View File

@@ -1,18 +1,7 @@
TOP = ../..
include $(TOP)/configure/CONFIG
LIBRARY += pvCopy
# This is a Makefile fragment, see ../Makefile
SHRLIB_VERSION ?= $(EPICS_PVA_MAJOR_VERSION).$(EPICS_PVA_MINOR_VERSION).$(EPICS_PVA_MAINTENANCE_VERSION)
# needed for Windows
LIB_SYS_LIBS_WIN32 += netapi32 ws2_32
INC += pv/pvPlugin.h
INC += pv/pvStructureCopy.h
INC += pv/pvArrayPlugin.h
INC += pv/pvDeadbandPlugin.h
INC += pv/pvTimestampPlugin.h
SRC_DIRS += $(PVDATABASE_SRC)/copy
LIBSRCS += pvPlugin.cpp
LIBSRCS += pvCopy.cpp
@@ -20,8 +9,4 @@ LIBSRCS += pvArrayPlugin.cpp
LIBSRCS += pvDeadbandPlugin.cpp
LIBSRCS += pvTimestampPlugin.cpp
pvCopy_LIBS += $(EPICS_BASE_PVA_CORE_LIBS)
pvCopy_LIBS += $(EPICS_BASE_IOC_LIBS)
include $(TOP)/configure/RULES

98
src/copy/pv/pvArrayPlugin.h
View File

@@ -1,98 +0,0 @@
/* pvArrayPlugin.h */
/*
* The License for this software can be found in the file LICENSE that is included with the distribution.
*/
#ifndef PVARRAYPLUGIN_H
#define PVARRAYPLUGIN_H
#include <string>
#include <map>
#include <pv/lock.h>
#include <pv/pvData.h>
#include <pv/pvPlugin.h>
#include <shareLib.h>
namespace epics { namespace pvCopy{
class PVArrayPlugin;
class PVArrayFilter;
typedef std::tr1::shared_ptr<PVArrayPlugin> PVArrayPluginPtr;
typedef std::tr1::shared_ptr<PVArrayFilter> PVArrayFilterPtr;
/**
* @brief A plugin for a filter that gets a sub array from a PVScalarArray.
*
* @author mrk
* @since date 2017.02.23
*/
class epicsShareClass PVArrayPlugin : public PVPlugin
{
private:
PVArrayPlugin();
public:
POINTER_DEFINITIONS(PVArrayPlugin);
virtual ~PVArrayPlugin();
/**
* Factory
*/
static void create();
/**
* Create a PVFilter.
* @param requestValue The value part of a name=value request option.
* @param pvCopy The PVCopy to which the PVFilter will be attached.
* @param master The field in the master PVStructure to which the PVFilter will be attached
* @return The PVFilter.
* Null is returned if master or requestValue is not appropriate for the plugin.
*/
virtual PVFilterPtr create(
const std::string & requestValue,
const PVCopyPtr & pvCopy,
const epics::pvData::PVFieldPtr & master);
};
/**
* @brief A filter that gets a sub array from a PVScalarArray.
*/
class epicsShareClass PVArrayFilter : public PVFilter
{
private:
long start;
long increment;
long end;
epics::pvData::PVScalarArrayPtr masterArray;
PVArrayFilter(long start,long increment,long end,const epics::pvData::PVScalarArrayPtr & masterArray);
public:
POINTER_DEFINITIONS(PVArrayFilter);
virtual ~PVArrayFilter();
/**
* Create a PVArrayFilter.
* @param requestValue The value part of a name=value request option.
* @param master The field in the master PVStructure to which the PVFilter will be attached.
* @return The PVFilter.
* A null is returned if master or requestValue is not appropriate for the plugin.
*/
static PVArrayFilterPtr create(const std::string & requestValue,const epics::pvData::PVFieldPtr & master);
/**
* Perform a filter operation
* @param pvCopy The field in the copy PVStructure.
* @param bitSet A bitSet for copyPVStructure.
* @param toCopy (true,false) means copy (from master to copy,from copy to master)
* @return if filter (modified, did not modify) destination.
* Null is returned if master or requestValue is not appropriate for the plugin.
*/
bool filter(const epics::pvData::PVFieldPtr & pvCopy,const epics::pvData::BitSetPtr & bitSet,bool toCopy);
/**
* Get the filter name.
* @return The name.
*/
std::string getName();
};
}}
#endif /* PVARRAYPLUGIN_H */

103
src/copy/pv/pvDeadbandPlugin.h
View File

@@ -1,103 +0,0 @@
/* pvDeadbandPlugin.h */
/*
* The License for this software can be found in the file LICENSE that is included with the distribution.
*/
#ifndef PVDEADBANDPLUGIN_H
#define PVDEADBANDPLUGIN_H
#include <string>
#include <map>
#include <pv/lock.h>
#include <pv/pvData.h>
#include <pv/pvPlugin.h>
#include <shareLib.h>
namespace epics { namespace pvCopy{
class PVDeadbandPlugin;
class PVDeadbandFilter;
typedef std::tr1::shared_ptr<PVDeadbandPlugin> PVDeadbandPluginPtr;
typedef std::tr1::shared_ptr<PVDeadbandFilter> PVDeadbandFilterPtr;
/**
* @brief A plugin for a filter that gets a sub array from a PVScalarDeadband.
*
* @author mrk
* @since date 2017.02.23
*/
class epicsShareClass PVDeadbandPlugin : public PVPlugin
{
private:
PVDeadbandPlugin();
public:
POINTER_DEFINITIONS(PVDeadbandPlugin);
virtual ~PVDeadbandPlugin();
/**
* Factory
*/
static void create();
/**
* Create a PVFilter.
* @param requestValue The value part of a name=value request option.
* @param pvCopy The PVCopy to which the PVFilter will be attached.
* @param master The field in the master PVStructure to which the PVFilter will be attached
* @return The PVFilter.
* Null is returned if master or requestValue is not appropriate for the plugin.
*/
virtual PVFilterPtr create(
const std::string & requestValue,
const PVCopyPtr & pvCopy,
const epics::pvData::PVFieldPtr & master);
};
/**
* @brief A Plugin for a filter that gets a sub array from a PVScalarDeadband.
*/
class epicsShareClass PVDeadbandFilter : public PVFilter
{
private:
bool absolute;
double deadband;
epics::pvData::PVScalarPtr master;
bool firstTime;
double lastReportedValue;
PVDeadbandFilter(bool absolute,double deadband,epics::pvData::PVScalarPtr const & master);
public:
POINTER_DEFINITIONS(PVDeadbandFilter);
virtual ~PVDeadbandFilter();
/**
* Create a PVDeadbandFilter.
* @param requestValue The value part of a name=value request option.
* @param master The field in the master PVStructure to which the PVFilter will be attached.
* @return The PVFilter.
* A null is returned if master or requestValue is not appropriate for the plugin.
*/
static PVDeadbandFilterPtr create(
const std::string & requestValue,
const epics::pvData::PVFieldPtr & master);
/**
* Perform a filter operation
* @param pvCopy The field in the copy PVStructure.
* @param bitSet A bitSet for copyPVStructure.
* @param toCopy (true,false) means copy (from master to copy,from copy to master)
* @return if filter (modified, did not modify) destination.
* Null is returned if master or requestValue is not appropriate for the plugin.
*/
bool filter(const epics::pvData::PVFieldPtr & pvCopy,const epics::pvData::BitSetPtr & bitSet,bool toCopy);
/**
* Get the filter name.
* @return The name.
*/
std::string getName();
};
}}
#endif /* PVDEADBANDPLUGIN_H */

109
src/copy/pv/pvPlugin.h
View File

@@ -1,109 +0,0 @@
/* pvPlugin.h */
/*
* The License for this software can be found in the file LICENSE that is included with the distribution.
*/
/**
* @author Marty Kraimer
* @date 2017.03
*/
#ifndef PVPLUGIN_H
#define PVPLUGIN_H
#include <string>
#include <map>
#include <pv/lock.h>
#include <pv/bitSet.h>
#include <shareLib.h>
namespace epics { namespace pvCopy{
class PVPlugin;
class PVFilter;
class PVPluginRegistry;
class PVCopy;
typedef std::tr1::shared_ptr<PVCopy> PVCopyPtr;
typedef std::tr1::shared_ptr<PVPlugin> PVPluginPtr;
typedef std::tr1::shared_ptr<PVFilter> PVFilterPtr;
typedef std::map<std::string,PVPluginPtr> PVPluginMap;
/**
* @brief 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.
*
*/
class epicsShareClass PVPlugin {
public:
POINTER_DEFINITIONS(PVPlugin);
virtual ~PVPlugin() {}
/**
* Create a PVFilter.
* @param requestValue The value part of a name=value request option.
* @param pvCopy The PVCopy to which the PVFilter will be attached.
* @param master The field in the master PVStructure to which the PVFilter will be attached.
* @return The PVFilter.
* A null is returned if master or requestValue is not appropriate for the plugin.
*/
virtual PVFilterPtr create(
const std::string & requestValue,
const PVCopyPtr & pvCopy,
const epics::pvData::PVFieldPtr & master) = 0;
};
/**
* @brief 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.
*/
class epicsShareClass PVFilter {
public:
POINTER_DEFINITIONS(PVFilter);
virtual ~PVFilter() {}
/**
* Update copy or master.
* @param copy The data for copy.
* @param bitSet The BitSet for copy.
* @param toCopy (true,false) means copy (from master to copy,from copy to master)
* @return (true,false) if filter modified destination.
*/
virtual bool filter(const epics::pvData::PVFieldPtr & copy,const epics::pvData::BitSetPtr & bitSet,bool toCopy) = 0;
/**
* Get the filter name.
* This is the name part of a request name=value pair.
* @return The name.
*/
virtual std::string getName() = 0;
};
/**
* @brief A registry for filter plugins for PVCopy.
*
*/
class epicsShareClass PVPluginRegistry {
public:
/**
* Register a plugin.
* @param name The name that appears in [name=value] of a field request option.
* @param pvPlugin The implementation for the plugin.
*/
static void registerPlugin(const std::string & name,const PVPluginPtr & pvPlugin);
/**
* Find a plugin.
* @param name The name that appears in [name=value] of a field request option.
* @return The plugin implementation or null if no pluging by that name has been registered.
*/
static PVPluginPtr find(const std::string & name);
};
}}
#endif /* PVPLUGIN_H */

248
src/copy/pv/pvStructureCopy.h
View File

@@ -1,248 +0,0 @@
/* pvStructureCopy.h */
/*
* Copyright information and license terms for this software can be
* found in the file LICENSE that is included with the distribution
*/
/**
* @author Marty Kraimer
* @date 2013.04
*/
#ifndef PVSTRUCTURECOPY_H
#define PVSTRUCTURECOPY_H
#include <string>
#include <stdexcept>
#include <memory>
#include <pv/pvData.h>
#include <pv/bitSet.h>
#include <shareLib.h>
namespace epics { namespace pvCopy{
class PVCopyTraverseMasterCallback;
typedef std::tr1::shared_ptr<PVCopyTraverseMasterCallback> PVCopyTraverseMasterCallbackPtr;
/**
* @brief Callback for traversing master structure
*
* Must be implemented by code that creates pvCopy.
*
* This was originally name pvCopy.h and implemented in pvDataCPP
* When it was moved to pvDatabaseCPP it was renamed to prevent conflicts with
* the version in pvDataCPP.
* Also the namespace was changed from epics::pvData to epics::pvCopy
*/
class epicsShareClass PVCopyTraverseMasterCallback
{
public:
POINTER_DEFINITIONS(PVCopyTraverseMasterCallback);
virtual ~PVCopyTraverseMasterCallback() {}
/**
* Called once for each field in master.
* @param pvField The field in master.
*/
virtual void nextMasterPVField(epics::pvData::PVFieldPtr const &pvField) = 0;
};
class PVCopy;
typedef std::tr1::shared_ptr<PVCopy> PVCopyPtr;
struct CopyNode;
typedef std::tr1::shared_ptr<CopyNode> CopyNodePtr;
struct CopyStructureNode;
typedef std::tr1::shared_ptr<CopyStructureNode> CopyStructureNodePtr;
/**
* @brief Support for subset of fields in a pvStructure.
*
* Class that manages one or more PVStructures that holds an arbitrary subset of the fields
* in another PVStructure called master.
*/
class epicsShareClass PVCopy :
public std::tr1::enable_shared_from_this<PVCopy>
{
public:
POINTER_DEFINITIONS(PVCopy);
/**
* Create a new pvCopy
* @param pvMaster The top-level structure for which a copy of
* an arbitrary subset of the fields in master will be created and managed.
* @param pvRequest Selects the set of subfields desired and options for each field.
* @param structureName The name for the top level of any PVStructure created.
*/
static PVCopyPtr create(
epics::pvData::PVStructurePtr const &pvMaster,
epics::pvData::PVStructurePtr const &pvRequest,
std::string const & structureName);
virtual ~PVCopy(){}
virtual void destroy();
/**
* Get the top-level structure of master
* @returns The master top-level structure.
* This should not be modified.
*/
epics::pvData::PVStructurePtr getPVMaster();
/**
* Traverse all the fields in master.
* @param callback This is called for each field on master.
*/
void traverseMaster(PVCopyTraverseMasterCallbackPtr const & callback);
/**
* Get the introspection interface for a PVStructure for e copy.
*/
epics::pvData::StructureConstPtr getStructure();
/**
* Create a copy instance. Monitors keep a queue of monitor elements.
* Since each element needs a PVStructure, multiple top-level structures will be created.
*/
epics::pvData::PVStructurePtr createPVStructure();
/**
* Given a field in pvMaster. return the offset in copy for the same field.
* A value of std::string::npos means that the copy does not have this field.
* @param masterPVField The field in master.
*/
std::size_t getCopyOffset(epics::pvData::PVFieldPtr const &masterPVField);
/**
* Given a field in pvMaster. return the offset in copy for the same field.
* A value of std::string::npos means that the copy does not have this field.
* @param masterPVStructure A structure in master that has masterPVField.
* @param masterPVField The field in master.
*/
std::size_t getCopyOffset(
epics::pvData::PVStructurePtr const &masterPVStructure,
epics::pvData::PVFieldPtr const &masterPVField);
/**
* Given an offset in the copy get the corresponding field in pvMaster.
* @param structureOffset The offset in the copy.
*/
epics::pvData::PVFieldPtr getMasterPVField(std::size_t structureOffset);
/**
* Initialize the fields in copyPVStructure by giving each field
* the value from the corresponding field in pvMaster.
* bitSet will be set to show that all fields are changed.
* @param copyPVStructure A copy top-level structure.
* @param bitSet A bitSet for copyPVStructure.
*/
void initCopy(
epics::pvData::PVStructurePtr const &copyPVStructure,
epics::pvData::BitSetPtr const &bitSet);
/**
* Set all fields in copyPVStructure to the value of the corresponding field in pvMaster.
* Each field that is changed has it's corresponding bit set in bitSet.
* @param copyPVStructure A copy top-level structure.
* @param bitSet A bitSet for copyPVStructure.
* @returns (false,true) if client (should not,should) receive changes.
*/
bool updateCopySetBitSet(
epics::pvData::PVStructurePtr const &copyPVStructure,
epics::pvData::BitSetPtr const &bitSet);
/**
* For each set bit in bitSet
* set the field in copyPVStructure to the value of the corresponding field in pvMaster.
* @param copyPVStructure A copy top-level structure.
* @param bitSet A bitSet for copyPVStructure.
* @returns (false,true) if client (should not,should) receive changes.
*/
bool updateCopyFromBitSet(
epics::pvData::PVStructurePtr const &copyPVStructure,
epics::pvData::BitSetPtr const &bitSet);
/**
* For each set bit in bitSet
* set the field in pvMaster to the value of the corresponding field in copyPVStructure
* @param copyPVStructure A copy top-level structure.
* @param bitSet A bitSet for copyPVStructure.
*/
void updateMaster(
epics::pvData::PVStructurePtr const &copyPVStructure,
epics::pvData::BitSetPtr const &bitSet);
/**
* Get the options for the field at the specified offset.
* @param fieldOffset the offset in copy.
* @returns A NULL is returned if no options were specified for the field.
* If options were specified,PVStructurePtr is a structures
* with a set of PVString subfields that specify name,value pairs.s
* name is the subField name and value is the subField value.
*/
epics::pvData::PVStructurePtr getOptions(std::size_t fieldOffset);
/**
* For debugging.
*/
std::string dump();
private:
PVCopyPtr getPtrSelf()
{
return shared_from_this();
}
epics::pvData::PVStructurePtr pvMaster;
epics::pvData::StructureConstPtr structure;
CopyNodePtr headNode;
epics::pvData::PVStructurePtr cacheInitStructure;
epics::pvData::BitSetPtr ignorechangeBitSet;
void traverseMaster(
CopyNodePtr const &node,
PVCopyTraverseMasterCallbackPtr const & callback);
void updateCopySetBitSet(
epics::pvData::PVFieldPtr const &pvCopy,
epics::pvData::PVFieldPtr const &pvMaster,
epics::pvData::BitSetPtr const &bitSet);
void updateCopySetBitSet(
epics::pvData::PVFieldPtr const &pvCopy,
CopyNodePtr const &node,
epics::pvData::BitSetPtr const &bitSet);
void updateCopyFromBitSet(
epics::pvData::PVFieldPtr const &pvCopy,
CopyNodePtr const &node,
epics::pvData::BitSetPtr const &bitSet);
void updateMasterField(
CopyNodePtr const & node,
epics::pvData::PVFieldPtr const & pvCopy,
epics::pvData::PVFieldPtr const &pvMaster,
epics::pvData::BitSetPtr const &bitSet);
void updateMasterCheckBitSet(
epics::pvData::PVStructurePtr const &copyPVStructure,
epics::pvData::BitSetPtr const &bitSet,
size_t nextSet);
CopyNodePtr getCopyNode(std::size_t fieldOffset);
PVCopy(epics::pvData::PVStructurePtr const &pvMaster);
bool init(epics::pvData::PVStructurePtr const &pvRequest);
epics::pvData::StructureConstPtr createStructure(
epics::pvData::PVStructurePtr const &pvMaster,
epics::pvData::PVStructurePtr const &pvFromRequest);
CopyNodePtr createStructureNodes(
epics::pvData::PVStructurePtr const &pvMasterStructure,
epics::pvData::PVStructurePtr const &pvFromRequest,
epics::pvData::PVStructurePtr const &pvFromField);
void initPlugin(
CopyNodePtr const & node,
epics::pvData::PVStructurePtr const & pvOptions,
epics::pvData::PVFieldPtr const & pvMasterField);
void traverseMasterInitPlugin();
void traverseMasterInitPlugin(CopyNodePtr const & node);
CopyNodePtr getCopyOffset(
CopyStructureNodePtr const &structureNode,
epics::pvData::PVFieldPtr const &masterPVField);
bool checkIgnore(
epics::pvData::PVStructurePtr const & copyPVStructure,
epics::pvData::BitSetPtr const & bitSet);
void setIgnore(CopyNodePtr const & node);
CopyNodePtr getMasterNode(
CopyStructureNodePtr const &structureNode,
std::size_t structureOffset);
void dump(
std::string *builder,
CopyNodePtr const &node,
int indentLevel);
};
}}
#endif /* PVSTRUCTURECOPY_H */

101
src/copy/pv/pvTimestampPlugin.h
View File

@@ -1,101 +0,0 @@
/* pvTimeStampPlugin.h */
/*
* The License for this software can be found in the file LICENSE that is included with the distribution.
*/
#ifndef PVTIMESTAMPPLUGIN_H
#define PVTIMESTAMPPLUGIN_H
#include <string>
#include <map>
#include <pv/lock.h>
#include <pv/pvData.h>
#include <pv/pvPlugin.h>
#include <pv/pvTimeStamp.h>
#include <shareLib.h>
namespace epics { namespace pvCopy{
class PVTimestampPlugin;
class PVTimestampFilter;
typedef std::tr1::shared_ptr<PVTimestampPlugin> PVTimestampPluginPtr;
typedef std::tr1::shared_ptr<PVTimestampFilter> PVTimestampFilterPtr;
/**
* @brief A plugin for a filter that sets a timeStamp to the current time.
*
* @author mrk
* @since date 2017.03.24
*/
class epicsShareClass PVTimestampPlugin : public PVPlugin
{
private:
PVTimestampPlugin();
public:
POINTER_DEFINITIONS(PVTimestampPlugin);
virtual ~PVTimestampPlugin();
/**
* Factory
*/
static void create();
/**
* Create a PVFilter.
* @param requestValue The value part of a name=value request option.
* @param pvCopy The PVCopy to which the PVFilter will be attached.
* @param master The field in the master PVStructure to which the PVFilter will be attached
* @return The PVFilter.
* Null is returned if master or requestValue is not appropriate for the plugin.
*/
virtual PVFilterPtr create(
const std::string & requestValue,
const PVCopyPtr & pvCopy,
const epics::pvData::PVFieldPtr & master);
};
/**
* @brief A filter that sets a timeStamp to/from the current field or pvCopy.
*/
class epicsShareClass PVTimestampFilter : public PVFilter
{
private:
epics::pvData::PVTimeStamp pvTimeStamp;
epics::pvData::TimeStamp timeStamp;
bool current;
bool copy;
epics::pvData::PVFieldPtr master;
PVTimestampFilter(bool current,bool copy,epics::pvData::PVFieldPtr const & pvField);
public:
POINTER_DEFINITIONS(PVTimestampFilter);
virtual ~PVTimestampFilter();
/**
* Create a PVTimestampFilter.
* @param requestValue The value part of a name=value request option.
* @param master The field in the master PVStructure to which the PVFilter will be attached.
* @return The PVFilter.
* A null is returned if master or requestValue is not appropriate for the plugin.
*/
static PVTimestampFilterPtr create(const std::string & requestValue,const epics::pvData::PVFieldPtr & master);
/**
* Perform a filter operation
* @param pvCopy The field in the copy PVStructure.
* @param bitSet A bitSet for copyPVStructure.
* @param toCopy (true,false) means copy (from master to copy,from copy to master)
* @return if filter (modified, did not modify) destination.
* Null is returned if master or requestValue is not appropriate for the plugin.
*/
bool filter(const epics::pvData::PVFieldPtr & pvCopy,const epics::pvData::BitSetPtr & bitSet,bool toCopy);
/**
* Get the filter name.
* @return The name.
*/
std::string getName();
};
}}
#endif /* PVTIMESTAMPPLUGIN_H */