epics::pvCopy::PVCopy Class Reference

Support for subset of fields in a pvStructure. More...

#include "pvStructureCopy.h"

Inheritance diagram for epics::pvCopy::PVCopy:

Collaboration diagram for epics::pvCopy::PVCopy:

Public Member Functions
	POINTER_DEFINITIONS (PVCopy)
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 ()

Static Public Member Functions
static PVCopyPtr	create (epics::pvData::PVStructurePtr const &pvMaster, epics::pvData::PVStructurePtr const &pvRequest, std::string const &structureName)

Detailed Description

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.

Definition at line 65 of file pvStructureCopy.h.

Constructor & Destructor Documentation

virtual epics::pvCopy::PVCopy::~PVCopy ( )

inlinevirtual

Definition at line 81 of file pvStructureCopy.h.

{}

Member Function Documentation

PVCopyPtr epics::pvCopy::PVCopy::create ( epics::pvData::PVStructurePtr const &  pvMaster, epics::pvData::PVStructurePtr const &  pvRequest, std::string const &  structureName  )

static

Create a new pvCopy

Parameters

pvMaster	The top-level structure for which a copy of an arbitrary subset of the fields in master will be created and managed.
pvRequest	Selects the set of subfields desired and options for each field.
structureName	The name for the top level of any PVStructure created.

Definition at line 73 of file pvCopy.cpp.

{
    PVStructurePtr pvStructure(pvRequest);
    if(structureName.size()>0) {
        if(pvStructure->getStructure()->getNumberFields()>0) {
            pvStructure = pvRequest->getSubField<PVStructure>(structureName);
            if(!pvStructure) return NULLPVCopy;
        }
    } else if(pvRequest->getSubField<PVStructure>("field")) {
        pvStructure = pvRequest->getSubField<PVStructure>("field");
    }
    PVCopyPtr pvCopy = PVCopyPtr(new PVCopy(pvMaster));
    bool result = pvCopy->init(pvStructure);
    if(!result) return PVCopyPtr();
    pvCopy->traverseMasterInitPlugin();
//cout << pvCopy->dump() << endl;
    return pvCopy;
}

PVStructurePtr epics::pvCopy::PVCopy::createPVStructure

(

)

Create a copy instance. Monitors keep a queue of monitor elements. Since each element needs a PVStructure, multiple top-level structures will be created.

Definition at line 110 of file pvCopy.cpp.

{
    if(cacheInitStructure) {
        PVStructurePtr save = cacheInitStructure;
        cacheInitStructure.reset();
        return save;
    }
    PVStructurePtr pvStructure =
        getPVDataCreate()->createPVStructure(structure);
    return pvStructure;
}

void epics::pvCopy::PVCopy::destroy ( )

virtual

Definition at line 431 of file pvCopy.cpp.

{
    headNode.reset();
}

string epics::pvCopy::PVCopy::dump

(

)

For debugging.

Definition at line 327 of file pvCopy.cpp.

{
    string builder;
    dump(&builder,headNode,0);
    return builder;
}

size_t epics::pvCopy::PVCopy::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.

Parameters

masterPVField

The field in master.

Definition at line 123 of file pvCopy.cpp.

{
    if(!headNode->isStructure) {
        CopyNodePtr node = static_pointer_cast<CopyNode>(headNode);
        if((node->masterPVField.get())==masterPVField.get()) {
             return headNode->structureOffset;
        }
        PVStructure * parent = masterPVField->getParent();
        size_t offsetParent = parent->getFieldOffset();
        size_t off = masterPVField->getFieldOffset();
        size_t offdiff = off -offsetParent;
        if(offdiff<node->nfields) return headNode->structureOffset + offdiff;
        return string::npos;
    }
    CopyStructureNodePtr structNode = static_pointer_cast<CopyStructureNode>(headNode);
    CopyNodePtr node = getCopyOffset(structNode,masterPVField);
    if(node) return node->structureOffset;
    return string::npos;
}

size_t epics::pvCopy::PVCopy::getCopyOffset	(	epics::pvData::PVStructurePtr const &	masterPVStructure,
		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.

Parameters

masterPVStructure	A structure in master that has masterPVField.
masterPVField	The field in master.

Definition at line 143 of file pvCopy.cpp.

{
    CopyNodePtr node;
    if(!headNode->isStructure) {
        node = static_pointer_cast<CopyNode>(headNode);
        if(node->masterPVField.get()!=masterPVStructure.get()) return string::npos;
    } else {
        CopyStructureNodePtr snode = static_pointer_cast<CopyStructureNode>(headNode);
        node = getCopyOffset(snode,masterPVField);
    }
    if(!node) return string::npos;
    size_t diff = masterPVField->getFieldOffset()
        - masterPVStructure->getFieldOffset();
    return node->structureOffset + diff;
}

PVFieldPtr epics::pvCopy::PVCopy::getMasterPVField

(

std::size_t

structureOffset

)

Given an offset in the copy get the corresponding field in pvMaster.

Parameters

structureOffset

The offset in the copy.

Definition at line 161 of file pvCopy.cpp.

{
    CopyNodePtr node;
    if(!headNode->isStructure) {
        node = headNode;
    } else {
        CopyStructureNodePtr snode = static_pointer_cast<CopyStructureNode>(headNode);
        node = getMasterNode(snode,structureOffset);
    }
    if(!node) {
        throw std::logic_error(
            "PVCopy::getMasterPVField: structureOffset not valid");
    }
    size_t diff = structureOffset - node->structureOffset;
    PVFieldPtr pvMasterField = node->masterPVField;
    if(diff==0) return pvMasterField;
    PVStructurePtr pvStructure
        = static_pointer_cast<PVStructure>(pvMasterField);
    return pvStructure->getSubField(
        pvMasterField->getFieldOffset() + diff);
}

PVStructurePtr epics::pvCopy::PVCopy::getOptions

(

std::size_t

fieldOffset

)

Get the options for the field at the specified offset.

Parameters

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.

Definition at line 300 of file pvCopy.cpp.

{
    if(fieldOffset==0) return headNode->options;
    CopyNodePtr node = headNode;
    while(true) {
        if(node->structureOffset==fieldOffset) return node->options;
        if(!node->isStructure) return NULLPVStructure;
        CopyStructureNodePtr structNode = static_pointer_cast<CopyStructureNode>(node);
        CopyNodePtrArrayPtr nodes = structNode->nodes;
        bool okToContinue = false;
        for(size_t i=0; i< nodes->size(); i++) {
            node = (*nodes)[i];
            size_t soff = node->structureOffset;
            if(fieldOffset>=soff && fieldOffset<soff+node->nfields) {
                if(fieldOffset==soff) return node->options;
                if(!node->isStructure) {
                    return NULLPVStructure;
                }
                okToContinue = true;
                break;
            }
        }
        if(okToContinue) continue;
        throw std::logic_error("PVCopy::getOptions logic error: fieldOffset not valid");
    }
}

PVStructurePtr epics::pvCopy::PVCopy::getPVMaster

(

)

Get the top-level structure of master

Returns

The master top-level structure. This should not be modified.

Definition at line 95 of file pvCopy.cpp.

{
    return pvMaster;
}

StructureConstPtr epics::pvCopy::PVCopy::getStructure

(

)

Get the introspection interface for a PVStructure for e copy.

Definition at line 105 of file pvCopy.cpp.

{
    return structure;
}

void epics::pvCopy::PVCopy::initCopy	(	epics::pvData::PVStructurePtr const &	copyPVStructure,
		epics::pvData::BitSetPtr const &	bitSet
	)

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.

Parameters

copyPVStructure	A copy top-level structure.
bitSet	A bitSet for copyPVStructure.

Definition at line 183 of file pvCopy.cpp.

{
    for(size_t i=0; i< copyPVStructure->getNumberFields(); ++i) {
        bitSet->set(i,true);
    }
    updateCopyFromBitSet(copyPVStructure,headNode,bitSet);
}

epics::pvCopy::PVCopy::POINTER_DEFINITIONS

(

PVCopy

)

void epics::pvCopy::PVCopy::traverseMaster

(

PVCopyTraverseMasterCallbackPtr const &

callback

)

Traverse all the fields in master.

Parameters

callback

This is called for each field on master.

Definition at line 100 of file pvCopy.cpp.

{
    traverseMaster(headNode,callback);
}

bool epics::pvCopy::PVCopy::updateCopyFromBitSet	(	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.

Parameters

copyPVStructure	A copy top-level structure.
bitSet	A bitSet for copyPVStructure.

Returns

(false,true) if client (should not,should) receive changes.

Definition at line 202 of file pvCopy.cpp.

{
    if(bitSet->get(0)) {
        for(size_t i=0; i< copyPVStructure->getNumberFields(); ++i) {
            bitSet->set(i,true);
        }
    }
    updateCopyFromBitSet(copyPVStructure,headNode,bitSet);
    return checkIgnore(copyPVStructure,bitSet);
}

bool epics::pvCopy::PVCopy::updateCopySetBitSet	(	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.

Parameters

copyPVStructure	A copy top-level structure.
bitSet	A bitSet for copyPVStructure.

Returns

(false,true) if client (should not,should) receive changes.

Definition at line 194 of file pvCopy.cpp.

{
    updateCopySetBitSet(copyPVStructure,headNode,bitSet);
    return checkIgnore(copyPVStructure,bitSet);
}

void epics::pvCopy::PVCopy::updateMaster	(	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

Parameters

copyPVStructure	A copy top-level structure.
bitSet	A bitSet for copyPVStructure.

Definition at line 280 of file pvCopy.cpp.

{
    updateMasterCheckBitSet(copyPVStructure,bitSet,0);
    size_t nextSet =0;
    while(true) {
        nextSet = bitSet->nextSetBit(nextSet);
        if(nextSet==string::npos) return;
        PVFieldPtr pvCopy = copyPVStructure->getSubField(nextSet);
        PVFieldPtr pvMaster = headNode->masterPVField;
        if(pvMaster->getField()->getType()==epics::pvData::structure) {
             PVStructurePtr pv = static_pointer_cast<PVStructure>(pvMaster);
             pvMaster = pv->getSubField(pvCopy->getFullName());
        }
        updateMasterField(getCopyNode(nextSet),pvCopy,pvMaster,bitSet);
        bitSet->clear(nextSet);
    }
}

---

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

• modules/pvDatabase/src/pv/pvStructureCopy.h
• modules/pvDatabase/src/copy/pvCopy.cpp