Process another record in the same database. More...

#include "processRecord.h"

Inheritance diagram for epics::pvDatabase::ProcessRecord:

Collaboration diagram for epics::pvDatabase::ProcessRecord:

Public Member Functions
	POINTER_DEFINITIONS (ProcessRecord)

virtual bool	init ()

virtual void	process ()
	Process the record specified by recordName. More...

virtual void	run ()
	The run method for the thread. More...

void	startThread ()
	Start the thread. More...

void	stop ()
	Stop the thread. More...

Public Member Functions inherited from epics::pvDatabase::PVRecord
	POINTER_DEFINITIONS (PVRecord)

virtual	~PVRecord ()

virtual void	start ()
	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 ProcessRecordPtr	create (std::string const &recordName, double delay)

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

Additional Inherited Members
Protected Member Functions inherited from epics::pvDatabase::PVRecord
	PVRecord (std::string const &recordName, epics::pvData::PVStructurePtr const &pvStructure)
	Constructor. More...

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

Detailed Description

Process another record in the same database.

A record to process another record It is meant to be used via a channelPutGet request. The argument has one field: recordName. The result has a field named status.

Definition at line 36 of file processRecord.h.

Member Function Documentation

ProcessRecordPtr epics::pvDatabase::ProcessRecord::create	(	std::string const &	recordName,
		double	delay
	)

static

Factory methods to create ProcessRecord.

Parameters

recordName	The name for the ProcessRecord.
delay	Delay time to wait between process requests.

Returns: A shared pointer to ProcessRecord.

Definition at line 43 of file processRecord.cpp.

 {
     FieldCreatePtr fieldCreate = getFieldCreate();
     PVDataCreatePtr pvDataCreate = getPVDataCreate();
     StructureConstPtr  topStructure = fieldCreate->createFieldBuilder()->
         addNestedStructure("argument")->
             add("command",pvString)->
             add("recordName",pvString)->
             endNested()->
         addNestedStructure("result") ->
             add("status",pvString) ->
             endNested()->
         createStructure();
     PVStructurePtr pvStructure = pvDataCreate->createPVStructure(topStructure);
     ProcessRecordPtr pvRecord(
         new ProcessRecord(recordName,pvStructure,delay));
     if(!pvRecord->init()) pvRecord.reset();
     return pvRecord;
 }

bool epics::pvDatabase::ProcessRecord::init ( )

virtual

standard init method required by PVRecord

Returns: true unless record name already exists.

Reimplemented from epics::pvDatabase::PVRecord.

Definition at line 90 of file processRecord.cpp.

 {
     initPVRecord();
     PVStructurePtr pvStructure = getPVStructure();
     pvCommand = pvStructure->getSubField<PVString>("argument.command");
     pvRecordName = pvStructure->getSubField<PVString>("argument.recordName");
     if(!pvRecordName) return false;
     pvResult = pvStructure->getSubField<PVString>("result.status");
     if(!pvResult) return false;
     startThread();
     return true;
 }

epics::pvDatabase::ProcessRecord::POINTER_DEFINITIONS ( ProcessRecord )

void epics::pvDatabase::ProcessRecord::process ( )

virtual

Process the record specified by recordName.

Reimplemented from epics::pvDatabase::PVRecord.

Definition at line 103 of file processRecord.cpp.

 {
     string recordName = pvRecordName->get();
     string command = pvCommand->get();
     if(command.compare("add")==0) {
         epicsGuard<epics::pvData::Mutex> guard(mutex);
         std::map<std::string,PVRecordPtr>::iterator iter = pvRecordMap.find(recordName);
         if(iter!=pvRecordMap.end()) {
              pvResult->put(recordName + " already present");
              return;
         }
         PVRecordPtr pvRecord = pvDatabase->findRecord(recordName);
         if(!pvRecord) {
              pvResult->put(recordName + " not in pvDatabase");
              return;
         }
         pvRecordMap.insert(PVRecordMap::value_type(recordName,pvRecord));
         pvResult->put("success");
         return;
     } else if(command.compare("remove")==0) {
         epicsGuard<epics::pvData::Mutex> guard(mutex);
         std::map<std::string,PVRecordPtr>::iterator iter = pvRecordMap.find(recordName);
         if(iter==pvRecordMap.end()) {
              pvResult->put(recordName + " not found");
              return;
         }
         pvRecordMap.erase(iter);
         pvResult->put("success");
         return;
     } else {
         pvResult->put(command  + " not a valid command: only add and remove are valid");
         return;
     }
 }

void epics::pvDatabase::ProcessRecord::run ( )

virtual

The run method for the thread.

Definition at line 138 of file processRecord.cpp.

 {
     while(true) {
         if(runStop.tryWait()) {
              runReturn.signal();
              return;
         }
         if(delay>0.0) epicsThreadSleep(delay);
         epicsGuard<epics::pvData::Mutex> guard(mutex);
         PVRecordMap::iterator iter;
         for(iter = pvRecordMap.begin(); iter!=pvRecordMap.end(); ++iter) {
            PVRecordPtr pvRecord = (*iter).second;
            pvRecord->lock();
            pvRecord->beginGroupPut();
            try {
                pvRecord->process();
            } catch (std::exception& ex) {
                std::cout << "record " << pvRecord->getRecordName() << "exception " << ex.what() << "\n";
            } catch (...) {
                std::cout<< "record " << pvRecord->getRecordName() << " process exception\n";
            }
            pvRecord->endGroupPut();
            pvRecord->unlock();
         }
     }
 }

void epics::pvDatabase::ProcessRecord::startThread ( )

Start the thread.

Definition at line 64 of file processRecord.cpp.

 {
     thread = EpicsThreadPtr(new epicsThread(
         *this,
         "processRecord",
         epicsThreadGetStackSize(epicsThreadStackSmall),
         epicsThreadPriorityLow));
     thread->start();
 }

void epics::pvDatabase::ProcessRecord::stop ( )

Stop the thread.

Definition at line 74 of file processRecord.cpp.

 {
     runStop.signal();
     runReturn.wait();
 }

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

modules/pvDatabase/src/pv/processRecord.h
modules/pvDatabase/src/special/processRecord.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation