epics::pvDatabase::MonitorLocal Class Reference

Inheritance diagram for epics::pvDatabase::MonitorLocal:

Collaboration diagram for epics::pvDatabase::MonitorLocal:

Public Member Functions
	POINTER_DEFINITIONS (MonitorLocal)
virtual	~MonitorLocal ()
virtual void	destroy ()
virtual Status	start ()
virtual Status	stop ()
virtual MonitorElementPtr	poll ()
virtual void	detach (PVRecordPtr const &pvRecord)
	Detach from the record because it is being removed. More...
virtual void	release (MonitorElementPtr const &monitorElement)
virtual void	dataPut (PVRecordFieldPtr const &pvRecordField)
	pvField has been modified. More...
virtual void	dataPut (PVRecordStructurePtr const &requested, PVRecordFieldPtr const &pvRecordField)
	A subfield has been modified. More...
virtual void	beginGroupPut (PVRecordPtr const &pvRecord)
	Begin a set of puts. More...
virtual void	endGroupPut (PVRecordPtr const &pvRecord)
	End a set of puts. More...
virtual void	unlisten (PVRecordPtr const &pvRecord)
	Connection to record is being terminated. More...
MonitorElementPtr	getActiveElement ()
void	releaseActiveElement ()
bool	init (PVStructurePtr const &pvRequest)
	MonitorLocal (MonitorRequester::shared_pointer const &channelMonitorRequester, PVRecordPtr const &pvRecord)
PVCopyPtr	getPVCopy ()
Public Member Functions inherited from epics::pvAccess::Monitor
	POINTER_DEFINITIONS (Monitor)
virtual	~Monitor ()
virtual void	getStats (Stats &s) const
virtual void	reportRemoteQueueStatus (epics::pvData::int32 freeElements)
Public Member Functions inherited from epics::pvAccess::Destroyable
	POINTER_DEFINITIONS (Destroyable)
Public Member Functions inherited from epics::pvDatabase::PVListener
	POINTER_DEFINITIONS (PVListener)
virtual	~PVListener ()
	Destructor. More...
Public Member Functions inherited from epics::pvDatabase::PVRecordClient
	POINTER_DEFINITIONS (PVRecordClient)
virtual	~PVRecordClient ()
	Destructor. More...

Additional Inherited Members
Public Types inherited from epics::pvAccess::Monitor
typedef MonitorRequester	requester_type
Protected Member Functions inherited from epics::pvAccess::Destroyable
virtual	~Destroyable ()

Detailed Description

Definition at line 135 of file monitorFactory.cpp.

Constructor & Destructor Documentation

epics::pvDatabase::MonitorLocal::~MonitorLocal ( )

virtual

Definition at line 192 of file monitorFactory.cpp.

{
//cout << "MonitorLocal::~MonitorLocal()" << endl;
}

epics::pvDatabase::MonitorLocal::MonitorLocal	(	MonitorRequester::shared_pointer const &	channelMonitorRequester,
		PVRecordPtr const &	pvRecord
	)

Definition at line 181 of file monitorFactory.cpp.

: monitorRequester(channelMonitorRequester),
  pvRecord(pvRecord),
  state(idle),
  isGroupPut(false),
  dataChanged(false)
{
}

Member Function Documentation

void epics::pvDatabase::MonitorLocal::beginGroupPut ( PVRecordPtr const &  pvRecord )

virtual

Begin a set of puts.

Parameters

pvRecord

The record.

Implements epics::pvDatabase::PVListener.

Definition at line 342 of file monitorFactory.cpp.

{
    if(pvRecord->getTraceLevel()>1)
    {
        cout << "MonitorLocal::beginGroupPut()" << endl;
    }
    if(state!=active) return;
    {
        Lock xx(mutex);
        isGroupPut = true;
        dataChanged = false;
    }
}

void epics::pvDatabase::MonitorLocal::dataPut ( PVRecordFieldPtr const &  pvRecordField )

virtual

pvField has been modified.

This is called if the listener has called PVRecordField::addListener for pvRecordField.

Parameters

pvRecordField

The modified field.

Implements epics::pvDatabase::PVListener.

Definition at line 290 of file monitorFactory.cpp.

{
    if(pvRecord->getTraceLevel()>1)
    {
        cout << "MonitorLocal::dataPut(pvRecordField)" << endl;
    }
    if(state!=active) return;
    {
        Lock xx(mutex);
        size_t offset = pvCopy->getCopyOffset(pvRecordField->getPVField());
        BitSetPtr const &changedBitSet = activeElement->changedBitSet;
        BitSetPtr const &overrunBitSet = activeElement->overrunBitSet;
        bool isSet = changedBitSet->get(offset);
        changedBitSet->set(offset);
        if(isSet) overrunBitSet->set(offset);
        dataChanged = true;
    }
    if(!isGroupPut) {
        releaseActiveElement();
        dataChanged = false;
    }
}

void epics::pvDatabase::MonitorLocal::dataPut ( PVRecordStructurePtr const &  requested, PVRecordFieldPtr const &  pvRecordField  )

virtual

A subfield has been modified.

Parameters

requested	The structure that was requested.
pvRecordField	The field that was modified.

Implements epics::pvDatabase::PVListener.

Definition at line 313 of file monitorFactory.cpp.

{
    if(pvRecord->getTraceLevel()>1)
    {
        cout << "MonitorLocal::dataPut(requested,pvRecordField)" << endl;
    }
    if(state!=active) return;
    {
        Lock xx(mutex);
        BitSetPtr const &changedBitSet = activeElement->changedBitSet;
        BitSetPtr const &overrunBitSet = activeElement->overrunBitSet;
        size_t offsetCopyRequested = pvCopy->getCopyOffset(
            requested->getPVField());
        size_t offset = offsetCopyRequested
             + (pvRecordField->getPVField()->getFieldOffset()
                 - requested->getPVField()->getFieldOffset());
        bool isSet = changedBitSet->get(offset);
        changedBitSet->set(offset);
        if(isSet) overrunBitSet->set(offset);
        dataChanged = true;
    }
    if(!isGroupPut) {
        releaseActiveElement();
        dataChanged = false;
    }
}

virtual void epics::pvDatabase::MonitorLocal::destroy ( )

inlinevirtual

Destroy this instance.

Implements epics::pvAccess::Destroyable.

Definition at line 144 of file monitorFactory.cpp.

{} // DEPRECATED

virtual void epics::pvDatabase::MonitorLocal::detach ( PVRecordPtr const &  pvRecord )

inlinevirtual

Detach from the record because it is being removed.

Parameters

pvRecord

The record.

Implements epics::pvDatabase::PVRecordClient.

Definition at line 148 of file monitorFactory.cpp.

{}

void epics::pvDatabase::MonitorLocal::endGroupPut ( PVRecordPtr const &  pvRecord )

virtual

End a set of puts.

Parameters

pvRecord

The record.

Implements epics::pvDatabase::PVListener.

Definition at line 356 of file monitorFactory.cpp.

{
    if(pvRecord->getTraceLevel()>1)
    {
        cout << "MonitorLocal::endGroupPut dataChanged " << dataChanged << endl;
    }
    if(state!=active) return;
    {
        Lock xx(mutex);
        isGroupPut = false;
    }
    if(dataChanged) {
        dataChanged = false;
        releaseActiveElement();
    }
}

MonitorElementPtr epics::pvDatabase::MonitorLocal::getActiveElement

(

)

PVCopyPtr epics::pvDatabase::MonitorLocal::getPVCopy ( )

inline

Definition at line 163 of file monitorFactory.cpp.

{ return pvCopy;}

bool epics::pvDatabase::MonitorLocal::init

(

PVStructurePtr const &

pvRequest

)

Definition at line 394 of file monitorFactory.cpp.

{
    PVFieldPtr pvField;
    size_t queueSize = 2;
    PVStructurePtr pvOptions = pvRequest->getSubField<PVStructure>("record._options");
    MonitorRequesterPtr requester = monitorRequester.lock();
    if(!requester) return false;
    if(pvOptions) {
        PVStringPtr pvString  = pvOptions->getSubField<PVString>("queueSize");
        if(pvString) {
            try {
                int32 size;
                std::stringstream ss;
                ss << pvString->get();
                ss >> size;
                queueSize = size;
            } catch (...) {
                 requester->message("queueSize " +pvString->get() + " illegal",errorMessage);
                 return false;
            }
        }
    }
    pvField = pvRequest->getSubField("field");
    if(!pvField) {
        pvCopy = PVCopy::create(
            pvRecord->getPVRecordStructure()->getPVStructure(),
            pvRequest,"");
        if(!pvCopy) {
            requester->message("illegal pvRequest",errorMessage);
            return false;
        }
    } else {
        if(pvField->getField()->getType()!=structure) {
            requester->message("illegal pvRequest",errorMessage);
            return false;
        }
        pvCopy = PVCopy::create(
            pvRecord->getPVRecordStructure()->getPVStructure(),
            pvRequest,"field");
        if(!pvCopy) {
            requester->message("illegal pvRequest",errorMessage);
            return false;
        }
    }
    if(queueSize<2) queueSize = 2;
    std::vector<MonitorElementPtr> monitorElementArray;
    monitorElementArray.reserve(queueSize);
    for(size_t i=0; i<queueSize; i++) {
         PVStructurePtr pvStructure = pvCopy->createPVStructure();
         MonitorElementPtr monitorElement(
             new MonitorElement(pvStructure));
         monitorElementArray.push_back(monitorElement);
    }
    queue = MonitorElementQueuePtr(new MonitorElementQueue(monitorElementArray));
    requester->monitorConnect(
        Status::Ok,
        getPtrSelf(),
        pvCopy->getStructure());
    return true;
}

epics::pvDatabase::MonitorLocal::POINTER_DEFINITIONS

(

MonitorLocal

)

MonitorElementPtr epics::pvDatabase::MonitorLocal::poll ( )

virtual

If monitor has occurred return data.

Returns

monitorElement for modified data. Must call get to determine if data is available.

May recursively call MonitorRequester::unlisten()

Implements epics::pvAccess::Monitor.

Definition at line 238 of file monitorFactory.cpp.

{
    if(pvRecord->getTraceLevel()>1)
    {
        cout << "MonitorLocal::poll state  " << state << endl;
    }
    {
        Lock xx(queueMutex);
        if(state!=active) return NULLMonitorElement;
        return queue->getUsed();
    }
}

void epics::pvDatabase::MonitorLocal::release ( MonitorElementPtr const &  monitorElement )

virtual

Release a MonitorElement that was returned by poll. A poll() must be called after the release() to check the presence of any modified data.

Parameters

monitorElement

Implements epics::pvAccess::Monitor.

Definition at line 251 of file monitorFactory.cpp.

{
    if(pvRecord->getTraceLevel()>1)
    {
        cout << "MonitorLocal::release state  " << state << endl;
    }
    {
        Lock xx(queueMutex);
        if(state!=active) return;
        queue->releaseUsed(monitorElement);
    }
}

void epics::pvDatabase::MonitorLocal::releaseActiveElement

(

)

Definition at line 264 of file monitorFactory.cpp.

{
    if(pvRecord->getTraceLevel()>1)
    {
        cout << "MonitorLocal::releaseActiveElement  state  " << state << endl;
    }
    {
        Lock xx(queueMutex);
        if(state!=active) return;
        bool result = pvCopy->updateCopyFromBitSet(activeElement->pvStructurePtr,activeElement->changedBitSet);
        if(!result) return;
        MonitorElementPtr newActive = queue->getFree();
        if(!newActive) return;
        BitSetUtil::compress(activeElement->changedBitSet,activeElement->pvStructurePtr);
        BitSetUtil::compress(activeElement->overrunBitSet,activeElement->pvStructurePtr);
        queue->setUsed(activeElement);
        activeElement = newActive;
        activeElement->changedBitSet->clear();
        activeElement->overrunBitSet->clear();
    }
    MonitorRequesterPtr requester = monitorRequester.lock();
    if(!requester) return;
    requester->monitorEvent(getPtrSelf());
    return;
}

Status epics::pvDatabase::MonitorLocal::start ( )

virtual

Start monitoring.

Returns

completion status.

Implements epics::pvAccess::Monitor.

Definition at line 198 of file monitorFactory.cpp.

{
    if(pvRecord->getTraceLevel()>0)
    {
        cout << "MonitorLocal::start state " << state << endl;
    }
    {
        Lock xx(mutex);
        if(state==active) return alreadyStartedStatus;
        if(state==deleted) return deletedStatus;
    }
    pvRecord->addListener(getPtrSelf(),pvCopy);
    epicsGuard <PVRecord> guard(*pvRecord);
    Lock xx(mutex);
    state = active;
    queue->clear();
    isGroupPut = false;
    activeElement = queue->getFree();
    activeElement->changedBitSet->clear();
    activeElement->overrunBitSet->clear();
    activeElement->changedBitSet->set(0);
    releaseActiveElement();
    return Status::Ok;
}

Status epics::pvDatabase::MonitorLocal::stop ( )

virtual

Stop Monitoring.

Returns

completion status.

Implements epics::pvAccess::Monitor.

Definition at line 223 of file monitorFactory.cpp.

{
    if(pvRecord->getTraceLevel()>0){
        cout << "MonitorLocal::stop state " << state << endl;
    }
    {
        Lock xx(mutex);
        if(state==idle) return notStartedStatus;
        if(state==deleted) return deletedStatus;
        state = idle;
    }
    pvRecord->removeListener(getPtrSelf(),pvCopy);
    return Status::Ok;
}

void epics::pvDatabase::MonitorLocal::unlisten ( PVRecordPtr const &  pvRecord )

virtual

Connection to record is being terminated.

Parameters

pvRecord

The record.

Implements epics::pvDatabase::PVListener.

Definition at line 373 of file monitorFactory.cpp.

{
    if(pvRecord->getTraceLevel()>1)
    {
        cout << "MonitorLocal::unlisten\n";
    }
    {
        Lock xx(mutex);
        state = deleted;
    }
    MonitorRequesterPtr requester = monitorRequester.lock();
    if(requester) {
        if(pvRecord->getTraceLevel()>1)
        {
            cout << "MonitorLocal::unlisten calling requester->unlisten\n";
        }
        requester->unlisten(getPtrSelf());
    }
}

---

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

• modules/pvDatabase/src/pvAccess/monitorFactory.cpp