pvStructureCopy.h

Go to the documentation of this file.

/* pvStructureCopy.h */
/*
 * Copyright information and license terms for this software can be
 * found in the file LICENSE that is included with the distribution
 */
#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;

class epicsShareClass PVCopyTraverseMasterCallback
{
public:
    POINTER_DEFINITIONS(PVCopyTraverseMasterCallback);
    virtual ~PVCopyTraverseMasterCallback() {}
    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;


class epicsShareClass PVCopy :
    public std::tr1::enable_shared_from_this<PVCopy>
{
public:
    POINTER_DEFINITIONS(PVCopy);
    static PVCopyPtr create(
        epics::pvData::PVStructurePtr const &pvMaster,
        epics::pvData::PVStructurePtr const &pvRequest,
        std::string const & structureName);
    virtual ~PVCopy(){}
    virtual void destroy();
    epics::pvData::PVStructurePtr getPVMaster();
    void traverseMaster(PVCopyTraverseMasterCallbackPtr const & callback);
    epics::pvData::StructureConstPtr getStructure();
    epics::pvData::PVStructurePtr createPVStructure();
    std::size_t getCopyOffset(epics::pvData::PVFieldPtr const  &masterPVField);
    std::size_t getCopyOffset(
        epics::pvData::PVStructurePtr const  &masterPVStructure,
        epics::pvData::PVFieldPtr const  &masterPVField);
    epics::pvData::PVFieldPtr getMasterPVField(std::size_t structureOffset);
    void initCopy(
        epics::pvData::PVStructurePtr const  &copyPVStructure,
        epics::pvData::BitSetPtr const  &bitSet);
    bool updateCopySetBitSet(
        epics::pvData::PVStructurePtr const  &copyPVStructure,
        epics::pvData::BitSetPtr const  &bitSet);
    bool updateCopyFromBitSet(
        epics::pvData::PVStructurePtr const  &copyPVStructure,
        epics::pvData::BitSetPtr const  &bitSet);
    void updateMaster(
        epics::pvData::PVStructurePtr const  &copyPVStructure,
        epics::pvData::BitSetPtr const  &bitSet);
    epics::pvData::PVStructurePtr getOptions(std::size_t fieldOffset);
    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 */