pvDatabaseCPP  4.5.1
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
epics::pvDatabase::AddRecord Class Reference

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

#include <addRecord.h>

Inheritance diagram for epics::pvDatabase::AddRecord:
epics::pvDatabase::PVRecord epics::pvCopy::PVCopyTraverseMasterCallback

Public Member Functions

 POINTER_DEFINITIONS (AddRecord)
 
virtual bool init ()
 
virtual void process ()
 Add the record specified by recordName. More...
 
 POINTER_DEFINITIONS (PVRecord)
 
 POINTER_DEFINITIONS (PVCopyTraverseMasterCallback)
 
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...
 

Static Public Member Functions

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

Protected Member Functions

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

Detailed Description

Add another record in the same database.

A record to add 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 32 of file addRecord.h.

Member Function Documentation

◆ addListener()

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

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

◆ addPVRecordClient()

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

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

◆ beginGroupPut()

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

Begins a group of puts.

Definition at line 318 of file pvRecord.cpp.

◆ create() [1/2]

AddRecordPtr epics::pvDatabase::AddRecord::create ( std::string const &  recordName)
static

Factory methods to create AddRecord.

Parameters
recordNameThe name for the AddRecord.
Returns
A shared pointer to AddRecord..

Definition at line 42 of file addRecord.cpp.

◆ create() [2/2]

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

Creates a soft record.

Parameters
recordNameThe name of the record, which is also the channelName.
pvStructureThe top level structure.
Returns
A shared pointer to the newly created record.

Definition at line 38 of file pvRecord.cpp.

◆ destroy()

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

DEPRECATED.

Definition at line 92 of file pvDatabase.h.

◆ endGroupPut()

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

Ends a group of puts.

Definition at line 333 of file pvRecord.cpp.

◆ findPVRecordField()

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

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 epics::pvDatabase::PVRecord::nextMasterPVField(), and epics::pvDatabase::PVRecord::process().

◆ getPVRecordStructure()

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

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
inlineinherited

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
inlineinherited

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)
inlinevirtualinherited

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 109 of file pvDatabase.h.

◆ getTraceLevel()

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

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

Returns
the level

Definition at line 233 of file pvDatabase.h.

◆ init()

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

standard init method required by PVRecord

Returns
true unless record name already exists.

Reimplemented from epics::pvDatabase::PVRecord.

Definition at line 71 of file addRecord.cpp.

◆ initPVRecord()

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

Initializes the base class.

Must be called by derived classes.

Definition at line 145 of file pvRecord.cpp.

◆ lock()

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

Lock the record.

Any code must lock while accessing a record.

Definition at line 199 of file pvRecord.cpp.

Referenced by epics::pvDatabase::PVRecord::lockOtherRecord().

◆ lockOtherRecord()

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

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

References epics::pvDatabase::PVRecord::lock(), and epics::pvDatabase::PVRecord::unlock().

◆ nextMasterPVField()

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

PVCopyTraverseMasterCallback method.

Parameters
pvFieldThe next client field.

Implements epics::pvCopy::PVCopyTraverseMasterCallback.

Definition at line 281 of file pvRecord.cpp.

References epics::pvDatabase::PVRecord::findPVRecordField().

◆ POINTER_DEFINITIONS() [1/3]

epics::pvDatabase::AddRecord::POINTER_DEFINITIONS ( AddRecord  )

◆ POINTER_DEFINITIONS() [2/3]

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

◆ POINTER_DEFINITIONS() [3/3]

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

◆ process()

void epics::pvDatabase::AddRecord::process ( )
virtual

Add the record specified by recordName.

Reimplemented from epics::pvDatabase::PVRecord.

Definition at line 82 of file addRecord.cpp.

◆ remove()

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

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

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

◆ removeListener()

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

Remove a listener.

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

Definition at line 293 of file pvRecord.cpp.

◆ setTraceLevel()

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

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 ( )
inlinevirtualinherited

Optional method for derived class.

It is called before record is added to database.

Definition at line 78 of file pvDatabase.h.

◆ tryLock()

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

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

◆ unlock()

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

Unlock the record.

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

Definition at line 206 of file pvRecord.cpp.

Referenced by epics::pvDatabase::PVRecord::lockOtherRecord().


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