pvDatabaseCPP  4.7.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
epics::pvDatabase::PVRecord Class Reference

Base interface for a PVRecord. More...

#include <pvDatabase.h>

Inheritance diagram for epics::pvDatabase::PVRecord:
epics::pvCopy::PVCopyTraverseMasterCallback epics::pvDatabase::PvdbcrAddRecord epics::pvDatabase::PvdbcrProcessRecord epics::pvDatabase::PvdbcrRemoveRecord epics::pvDatabase::PvdbcrScalarArrayRecord epics::pvDatabase::PvdbcrScalarRecord epics::pvDatabase::PvdbcrTraceRecord

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 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...
 
int getAsLevel () const
 Get the ASlevel. More...
 
std::string getAsGroup () const
 Get the AS group name. More...
 
void setAsLevel (int level)
 set access security level. More...
 
void setAsGroup (const std::string &group)
 set access security group More...
 
 POINTER_DEFINITIONS (PVCopyTraverseMasterCallback)
 

Static Public Member Functions

static PVRecordPtr create (std::string const &recordName, epics::pvData::PVStructurePtr const &pvStructure, int asLevel=0, const std::string &asGroup="DEFAULT")
 Creates a soft record. More...
 

Protected Member Functions

 PVRecord (std::string const &recordName, epics::pvData::PVStructurePtr const &pvStructure, int asLevel=0, const std::string &asGroup="DEFAULT")
 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

◆ ~PVRecord()

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

The Destructor.

Definition at line 67 of file pvRecord.cpp.

◆ PVRecord()

epics::pvDatabase::PVRecord::PVRecord ( std::string const &  recordName,
epics::pvData::PVStructurePtr const &  pvStructure,
int  asLevel = 0,
const std::string &  asGroup = "DEFAULT" 
)
protected

Constructor.

Parameters
recordNameThe name of the record
pvStructureThe top level PVStructutre
asLevelAS level (default: ASL0)
asGroupAS group (default: DEFAULT)

Definition at line 52 of file pvRecord.cpp.

Member Function Documentation

◆ addListener()

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
pvListenerThe listener.
pvCopyThe pvStructure that has the client fields.
Returns
true if the listener was added.

Definition at line 236 of file pvRecord.cpp.

◆ addPVRecordClient()

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
pvRecordClientThe client.
Returns
true if the client is added.

Definition at line 205 of file pvRecord.cpp.

◆ beginGroupPut()

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

Begins a group of puts.

Definition at line 289 of file pvRecord.cpp.

◆ create()

PVRecordPtr epics::pvDatabase::PVRecord::create ( std::string const &  recordName,
epics::pvData::PVStructurePtr const &  pvStructure,
int  asLevel = 0,
const std::string &  asGroup = "DEFAULT" 
)
static

Creates a soft record.

Parameters
recordNameThe name of the record, which is also the channelName.
pvStructureThe top level structure.
asLevelAS level (default: ASL0)
asGroupAS group (default: DEFAULT)
Returns
A shared pointer to the newly created record.

Definition at line 38 of file pvRecord.cpp.

◆ endGroupPut()

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

Ends a group of puts.

Definition at line 304 of file pvRecord.cpp.

◆ findPVRecordField()

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

Find the PVRecordField for the PVField.

This is called by the pvCopy facility.

Parameters
pvFieldThe PVField.
Returns
The shared pointer to the PVRecordField.

Referenced by nextMasterPVField(), and process().

◆ getAsGroup()

std::string epics::pvDatabase::PVRecord::getAsGroup ( ) const
inline

Get the AS group name.

Returns
The name.

Definition at line 250 of file pvDatabase.h.

◆ getAsLevel()

int epics::pvDatabase::PVRecord::getAsLevel ( ) const
inline

Get the ASlevel.

Returns
The level.

Definition at line 244 of file pvDatabase.h.

◆ getPVRecordStructure()

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

Get the top level PVRecordStructure.

Returns
The shared pointer.

Definition at line 135 of file pvDatabase.h.

Referenced by epics::pvDatabase::operator<<().

◆ getPVStructure()

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.

◆ getRecordName()

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.

Referenced by epics::pvDatabase::operator<<().

◆ getService()

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
pvRequestThe request PVStructure
Returns
The corresponding service

Definition at line 106 of file pvDatabase.h.

◆ getTraceLevel()

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.

◆ init()

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::PvdbcrProcessRecord, epics::pvDatabase::PvdbcrTraceRecord, epics::pvDatabase::PvdbcrAddRecord, and epics::pvDatabase::PvdbcrRemoveRecord.

Definition at line 73 of file pvDatabase.h.

◆ initPVRecord()

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

Initializes the base class.

Must be called by derived classes.

Definition at line 116 of file pvRecord.cpp.

◆ lock()

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

Lock the record.

Any code must lock while accessing a record.

Definition at line 170 of file pvRecord.cpp.

Referenced by lockOtherRecord().

◆ lockOtherRecord()

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
otherRecordThe other record to lock.

Definition at line 191 of file pvRecord.cpp.

References lock(), and unlock().

◆ nextMasterPVField()

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

PVCopyTraverseMasterCallback method.

Parameters
pvFieldThe next client field.

Implements epics::pvCopy::PVCopyTraverseMasterCallback.

Definition at line 252 of file pvRecord.cpp.

References findPVRecordField().

◆ POINTER_DEFINITIONS() [1/2]

epics::pvCopy::PVCopyTraverseMasterCallback::POINTER_DEFINITIONS ( PVCopyTraverseMasterCallback  )
inherited

◆ POINTER_DEFINITIONS() [2/2]

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

◆ process()

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::PvdbcrProcessRecord, epics::pvDatabase::PvdbcrTraceRecord, epics::pvDatabase::PvdbcrAddRecord, and epics::pvDatabase::PvdbcrRemoveRecord.

Definition at line 126 of file pvRecord.cpp.

References findPVRecordField().

◆ remove()

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 104 of file pvRecord.cpp.

References epics::pvDatabase::PVDatabase::getMaster().

◆ removeListener()

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

Remove a listener.

Parameters
pvListenerThe listener.
pvCopyThe pvStructure that has the client fields.
Returns
true if the listener was removed.

Definition at line 264 of file pvRecord.cpp.

◆ setAsGroup()

void epics::pvDatabase::PVRecord::setAsGroup ( const std::string &  group)
inline

set access security group

Parameters
groupThe group name

Definition at line 260 of file pvDatabase.h.

◆ setAsLevel()

void epics::pvDatabase::PVRecord::setAsLevel ( int  level)
inline

set access security level.

Parameters
levelThe level

Definition at line 255 of file pvDatabase.h.

◆ setTraceLevel()

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

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

Parameters
levelThe level

Definition at line 238 of file pvDatabase.h.

◆ start()

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

Optional method for derived class.

It is called before record is added to database.

Definition at line 79 of file pvDatabase.h.

◆ tryLock()

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 184 of file pvRecord.cpp.

◆ unlock()

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

Unlock the record.

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

Definition at line 177 of file pvRecord.cpp.

Referenced by lockOtherRecord().

Friends And Related Function Documentation

◆ PVDatabase

friend class PVDatabase
friend

Definition at line 280 of file pvDatabase.h.


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