epics::pvDatabase::RemoveRecord Class Reference

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

#include "removeRecord.h"

Inheritance diagram for epics::pvDatabase::RemoveRecord:

Collaboration diagram for epics::pvDatabase::RemoveRecord:

Public Member Functions
	POINTER_DEFINITIONS (RemoveRecord)
virtual bool	init ()
virtual void	process ()
	Remove the record specified by recordName. 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 RemoveRecordPtr	create (std::string const &recordName)
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

Remove another record in the same database.

A record to remove 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 removeRecord.h.

Member Function Documentation

RemoveRecordPtr epics::pvDatabase::RemoveRecord::create ( std::string const &  recordName )

static

Factory methods to create RemoveRecord.

Parameters

recordName

The name for the RemoveRecord.

Returns

A shared pointer to RemoveRecord..

Definition at line 41 of file removeRecord.cpp.

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

bool epics::pvDatabase::RemoveRecord::init ( )

virtual

standard init method required by PVRecord

Returns

true unless record name already exists.

Reimplemented from epics::pvDatabase::PVRecord.

Definition at line 68 of file removeRecord.cpp.

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

epics::pvDatabase::RemoveRecord::POINTER_DEFINITIONS

(

RemoveRecord

)

void epics::pvDatabase::RemoveRecord::process ( )

virtual

Remove the record specified by recordName.

Reimplemented from epics::pvDatabase::PVRecord.

Definition at line 79 of file removeRecord.cpp.

{
    string name = pvRecordName->get();
    PVRecordPtr pvRecord = PVDatabase::getMaster()->findRecord(name);
    if(!pvRecord) {
        pvResult->put(name + " not found");
        return;
    }
    pvRecord->remove();
    pvResult->put("success");
}

---

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

• modules/pvDatabase/src/pv/removeRecord.h
• modules/pvDatabase/src/special/removeRecord.cpp