Base interface for a PVRecord. More...

#include "pvDatabase.h"

Inheritance diagram for epics::pvDatabase::PVRecord:

Collaboration diagram for epics::pvDatabase::PVRecord:

Public Member Functions
	POINTER_DEFINITIONS (PVRecord)

virtual	~PVRecord ()

virtual bool	init ()
	Optional initialization method. More...

virtual void	start ()
	Optional method for derived class. More...

virtual void	process ()
	Optional method for derived class. More...

virtual void	destroy ()
	DEPRECATED. More...

virtual void	remove ()
	remove record from database. More...

virtual epics::pvAccess::RPCServiceAsync::shared_pointer	getService (epics::pvData::PVStructurePtr const &pvRequest)
	Optional method for derived class. More...

std::string	getRecordName () const
	Get the name of the record. More...

PVRecordStructurePtr	getPVRecordStructure () const
	Get the top level PVRecordStructure. More...

epics::pvData::PVStructurePtr	getPVStructure () const
	Get the top level PVStructure. More...

PVRecordFieldPtr	findPVRecordField (epics::pvData::PVFieldPtr const &pvField)
	Find the PVRecordField for the PVField. More...

void	lock ()
	Lock the record. More...

void	unlock ()
	Unlock the record. More...

bool	tryLock ()
	Try to lock the record. More...

void	lockOtherRecord (PVRecordPtr const &otherRecord)
	Lock another record. More...

bool	addPVRecordClient (PVRecordClientPtr const &pvRecordClient)
	Add a client that wants to access the record. More...

bool	addListener (PVListenerPtr const &pvListener, epics::pvCopy::PVCopyPtr const &pvCopy)
	Add a PVListener. More...

void	nextMasterPVField (epics::pvData::PVFieldPtr const &pvField)
	PVCopyTraverseMasterCallback method. More...

bool	removeListener (PVListenerPtr const &pvListener, epics::pvCopy::PVCopyPtr const &pvCopy)
	Remove a listener. More...

void	beginGroupPut ()
	Begins a group of puts. More...

void	endGroupPut ()
	Ends a group of puts. More...

int	getTraceLevel ()
	get trace level (0,1,2) means (nothing,lifetime,process) More...

void	setTraceLevel (int level)
	set trace level (0,1,2) means (nothing,lifetime,process) More...

Public Member Functions inherited from epics::pvCopy::PVCopyTraverseMasterCallback
	POINTER_DEFINITIONS (PVCopyTraverseMasterCallback)

virtual	~PVCopyTraverseMasterCallback ()

Static Public Member Functions
static PVRecordPtr	create (std::string const &recordName, epics::pvData::PVStructurePtr const &pvStructure)
	Creates a soft record. More...

Protected Member Functions
	PVRecord (std::string const &recordName, epics::pvData::PVStructurePtr const &pvStructure)
	Constructor. More...

void	initPVRecord ()
	Initializes the base class. More...

Friends
class	PVDatabase

Detailed Description

Base interface for a PVRecord.

It is also a complete implementation for soft records. A soft record is a record where method process sets an optional top level timeStamp field to the current time and does nothing else.

Author: mrk

Date: 2012.11.20

Definition at line 56 of file pvDatabase.h.

Constructor & Destructor Documentation

epics::pvDatabase::PVRecord::~PVRecord ( )

virtual

The Destructor.

Definition at line 61 of file pvRecord.cpp.

 {
     if(traceLevel>0) {
         cout << "~PVRecord() " << recordName << endl;
     }
 }

epics::pvDatabase::PVRecord::PVRecord	(	std::string const &	recordName,
		epics::pvData::PVStructurePtr const &	pvStructure
	)

protected

Constructor.

Parameters

recordName	The name of the record
pvStructure	The top level PVStructutre

Definition at line 50 of file pvRecord.cpp.

 : recordName(recordName),
   pvStructure(pvStructure),
   depthGroupPut(0),
   traceLevel(0),
   isAddListener(false)
 {
 }

Member Function Documentation

bool epics::pvDatabase::PVRecord::addListener	(	PVListenerPtr const &	pvListener,
		epics::pvCopy::PVCopyPtr const &	pvCopy
	)

Add a PVListener.

This must be called before calling pvRecordField.addListener.

Parameters

pvListener	The listener.
pvCopy	The pvStructure that has the client fields.

Returns: true if the listener was added.

Definition at line 230 of file pvRecord.cpp.

 {
     if(traceLevel>1) {
         cout << "PVRecord::addListener() " << recordName << endl;
     }
     epicsGuard<epics::pvData::Mutex> guard(mutex);
     pvListenerList.push_back(pvListener);
     this->pvListener = pvListener;
     isAddListener = true;
     pvCopy->traverseMaster(shared_from_this());
     this->pvListener = PVListenerPtr();;
     return true;
 }

bool epics::pvDatabase::PVRecord::addPVRecordClient ( PVRecordClientPtr const & pvRecordClient )

Add a client that wants to access the record.

Every client that accesses the record must call this so that the client can be notified when the record is deleted.

Parameters

pvRecordClient The client.

Returns: true if the client is added.

Definition at line 199 of file pvRecord.cpp.

 {
     if(traceLevel>1) {
         cout << "PVRecord::addPVRecordClient() " << recordName << endl;
     }
     epicsGuard<epics::pvData::Mutex> guard(mutex);
     // clean clientList
     bool clientListClean = false;
     while(!clientListClean) {
         if(clientList.empty()) break;
         clientListClean = true;
         std::list<PVRecordClientWPtr>::iterator iter;
         for (iter = clientList.begin();
              iter!=clientList.end();
              iter++ )
         {
             PVRecordClientPtr client = iter->lock();
             if(client) continue;
             if(traceLevel>1) {
                  cout << "PVRecord::addPVRecordClient() erasing client"
                       << recordName << endl;
             }
             clientList.erase(iter);
             clientListClean = false;
             break;
         }
     }
     clientList.push_back(pvRecordClient);
     return true;
 }

void epics::pvDatabase::PVRecord::beginGroupPut ( )

Begins a group of puts.

Definition at line 283 of file pvRecord.cpp.

 {
    if(++depthGroupPut>1) return;
     if(traceLevel>2) {
         cout << "PVRecord::beginGroupPut() " << recordName << endl;
     }
    std::list<PVListenerWPtr>::iterator iter;
    for (iter = pvListenerList.begin(); iter!=pvListenerList.end(); iter++)
    {
        PVListenerPtr listener = iter->lock();
        if(!listener.get()) continue;
        listener->beginGroupPut(shared_from_this());
    }
 }

PVRecordPtr epics::pvDatabase::PVRecord::create	(	std::string const &	recordName,
		epics::pvData::PVStructurePtr const &	pvStructure
	)

static

Creates a soft record.

Parameters

recordName	The name of the record, which is also the channelName.
pvStructure	The top level structure.

Returns: A shared pointer to the newly created record.

Definition at line 38 of file pvRecord.cpp.

 {
     PVRecordPtr pvRecord(new PVRecord(recordName,pvStructure));
     if(!pvRecord->init()) {
         pvRecord.reset();
     }
     return pvRecord;
 }

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

inlinevirtual

DEPRECATED.

Definition at line 92 of file pvDatabase.h.

92 {}

void epics::pvDatabase::PVRecord::endGroupPut ( )

Ends a group of puts.

Definition at line 298 of file pvRecord.cpp.

 {
    if(--depthGroupPut>0) return;
     if(traceLevel>2) {
         cout << "PVRecord::endGroupPut() " << recordName << endl;
     }
    std::list<PVListenerWPtr>::iterator iter;
    for (iter = pvListenerList.begin(); iter!=pvListenerList.end(); iter++)
    {
        PVListenerPtr listener = iter->lock();
        if(!listener.get()) continue;
        listener->endGroupPut(shared_from_this());
    }
 }

PVRecordFieldPtr epics::pvDatabase::PVRecord::findPVRecordField ( epics::pvData::PVFieldPtr const & pvField )

Find the PVRecordField for the PVField.

This is called by the pvCopy facility.

Parameters

pvField The PVField.

Returns: The shared pointer to the PVRecordField.

Definition at line 133 of file pvRecord.cpp.

 {
     return findPVRecordField(pvRecordStructure,pvField);
 }

PVRecordStructurePtr epics::pvDatabase::PVRecord::getPVRecordStructure ( ) const

inline

Get the top level PVRecordStructure.

Returns: The shared pointer.

Definition at line 135 of file pvDatabase.h.

135 { return pvRecordStructure;}

epics::pvData::PVStructurePtr epics::pvDatabase::PVRecord::getPVStructure ( ) const

inline

Get the top level PVStructure.

Returns: The top level PVStructure.

Definition at line 141 of file pvDatabase.h.

141 { return pvStructure;}

std::string epics::pvDatabase::PVRecord::getRecordName ( ) const

inline

Get the name of the record.

Returns: The name.

Definition at line 129 of file pvDatabase.h.

129 { return recordName;}

virtual epics::pvAccess::RPCServiceAsync::shared_pointer epics::pvDatabase::PVRecord::getService ( epics::pvData::PVStructurePtr const & pvRequest )

inlinevirtual

Optional method for derived class.

Return a service corresponding to the specified request PVStructure.

Parameters

pvRequest The request PVStructure

Returns: The corresponding service

Definition at line 109 of file pvDatabase.h.

     {
         return epics::pvAccess::RPCServiceAsync::shared_pointer();
     }

int epics::pvDatabase::PVRecord::getTraceLevel ( )

inline

get trace level (0,1,2) means (nothing,lifetime,process)

Returns: the level

Definition at line 233 of file pvDatabase.h.

233 {return traceLevel;}

virtual bool epics::pvDatabase::PVRecord::init ( )

inlinevirtual

Optional initialization method.

A derived method Must call initPVRecord.

Returns: true for success and false for failure.

Reimplemented in epics::pvDatabase::ProcessRecord, epics::pvDatabase::TraceRecord, epics::pvDatabase::AddRecord, and epics::pvDatabase::RemoveRecord.

Definition at line 72 of file pvDatabase.h.

72 {initPVRecord(); return true;}

epics::pvDatabase::PVRecord::initPVRecord

void initPVRecord()

Initializes the base class.

Definition: pvRecord.cpp:110

void epics::pvDatabase::PVRecord::initPVRecord ( )

protected

Initializes the base class.

Must be called by derived classes.

Definition at line 110 of file pvRecord.cpp.

 {
     PVRecordStructurePtr parent;
     pvRecordStructure = PVRecordStructurePtr(
         new PVRecordStructure(pvStructure,parent,shared_from_this()));
     pvRecordStructure->init();
     PVFieldPtr pvField = pvStructure->getSubField("timeStamp");
     if(pvField) pvTimeStamp.attach(pvField);
 }

void epics::pvDatabase::PVRecord::lock ( )

Lock the record.

Any code must lock while accessing a record.

Definition at line 164 of file pvRecord.cpp.

                     {
     if(traceLevel>2) {
         cout << "PVRecord::lock() " << recordName << endl;
     }
     mutex.lock();
 }

void epics::pvDatabase::PVRecord::lockOtherRecord ( PVRecordPtr const & otherRecord )

Lock another record.

A client that holds the lock for one record can lock one other record. A client must not call this if the client already has the lock for more then one record.

Parameters

otherRecord The other record to lock.

Definition at line 185 of file pvRecord.cpp.

 {
     if(traceLevel>2) {
         cout << "PVRecord::lockOtherRecord() " << recordName << endl;
     }
     if(this<otherRecord.get()) {
         otherRecord->lock();
         return;
     }
     unlock();
     otherRecord->lock();
     lock();
 }

void epics::pvDatabase::PVRecord::nextMasterPVField ( epics::pvData::PVFieldPtr const & pvField )

virtual

PVCopyTraverseMasterCallback method.

Parameters

pvField The next client field.

Implements epics::pvCopy::PVCopyTraverseMasterCallback.

Definition at line 246 of file pvRecord.cpp.

 {
      PVRecordFieldPtr pvRecordField = findPVRecordField(pvField);
      PVListenerPtr listener = pvListener.lock();
      if(!listener.get()) return;
      if(isAddListener) {
          pvRecordField->addListener(listener);
      } else {
          pvRecordField->removeListener(listener);
      }
 }

epics::pvDatabase::PVRecord::POINTER_DEFINITIONS ( PVRecord )

void epics::pvDatabase::PVRecord::process ( )

virtual

Optional method for derived class.

It is the method that makes a record smart. If it encounters errors it should raise alarms and/or call the message method provided by the base class. If the pvStructure has a top level timeStamp, the base class sets the timeStamp to the current time.

Reimplemented in epics::pvDatabase::ProcessRecord, epics::pvDatabase::TraceRecord, epics::pvDatabase::AddRecord, and epics::pvDatabase::RemoveRecord.

Definition at line 120 of file pvRecord.cpp.

 {
     if(traceLevel>2) {
         cout << "PVRecord::process() " << recordName << endl;
     }
     if(pvTimeStamp.isAttached()) {
         pvTimeStamp.get(timeStamp);
         timeStamp.getCurrent();
         pvTimeStamp.set(timeStamp);
     }
 }

void epics::pvDatabase::PVRecord::remove ( )

virtual

remove record from database.

Remove the PVRecord. Release any resources used and get rid of listeners and requesters. If derived class overrides this then it must call PVRecord::remove() after it has destroyed any resorces it uses.

Definition at line 98 of file pvRecord.cpp.

 {
     if(traceLevel>0) {
             cout << "PVRecord::remove() " << recordName << endl;
     }
     unlistenClients();
     epicsGuard<epics::pvData::Mutex> guard(mutex);
     PVDatabasePtr pvDatabase(PVDatabase::getMaster());
     if(pvDatabase) pvDatabase->removeFromMap(shared_from_this());
     pvTimeStamp.detach();
 }

bool epics::pvDatabase::PVRecord::removeListener	(	PVListenerPtr const &	pvListener,
		epics::pvCopy::PVCopyPtr const &	pvCopy
	)

Remove a listener.

Parameters

pvListener	The listener.
pvCopy	The pvStructure that has the client fields.

Returns: true if the listener was removed.

Definition at line 258 of file pvRecord.cpp.

 {
     if(traceLevel>1) {
         cout << "PVRecord::removeListener() " << recordName << endl;
     }
     epicsGuard<epics::pvData::Mutex> guard(mutex);
     std::list<PVListenerWPtr>::iterator iter;
     for (iter = pvListenerList.begin(); iter!=pvListenerList.end(); iter++ )
     {
         PVListenerPtr listener = iter->lock();
         if(!listener.get()) continue;
         if(listener.get()==pvListener.get()) {
             pvListenerList.erase(iter);
             this->pvListener = pvListener;
             isAddListener = false;
             pvCopy->traverseMaster(shared_from_this());
             this->pvListener = PVListenerPtr();
             return true;
         }
     }
     return false;
 }

void epics::pvDatabase::PVRecord::setTraceLevel ( int level )

inline

set trace level (0,1,2) means (nothing,lifetime,process)

Parameters

level The level

Definition at line 238 of file pvDatabase.h.

238 {traceLevel = level;}

virtual void epics::pvDatabase::PVRecord::start ( )

inlinevirtual

Optional method for derived class.

It is called before record is added to database.

Definition at line 78 of file pvDatabase.h.

78 {}

bool epics::pvDatabase::PVRecord::tryLock ( )

Try to lock the record.

If true then just like lock. If falseclient can not access record. Code can try to simultaneously hold the lock for more than two records by calling this method but must be willing to accept failure.

Returns: true if the record is locked.

Definition at line 178 of file pvRecord.cpp.

                        {
     if(traceLevel>2) {
         cout << "PVRecord::tryLock() " << recordName << endl;
     }
     return mutex.tryLock();
 }

void epics::pvDatabase::PVRecord::unlock ( )

Unlock the record.

The code that calls lock must unlock when done accessing the record.

Definition at line 171 of file pvRecord.cpp.

                       {
     if(traceLevel>2) {
         cout << "PVRecord::unlock() " << recordName << endl;
     }
     mutex.unlock();
 }

Friends And Related Function Documentation

friend class PVDatabase

friend

Definition at line 255 of file pvDatabase.h.

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

modules/pvDatabase/src/pv/pvDatabase.h
modules/pvDatabase/src/database/pvRecord.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation