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

The interface for a database of PVRecords. More...

#include <pvDatabase.h>

Public Member Functions

 POINTER_DEFINITIONS (PVDatabase)
 
virtual ~PVDatabase ()
 Destructor. More...
 
PVRecordPtr findRecord (std::string const &recordName)
 
bool addRecord (PVRecordPtr const &record)
 Add a record. More...
 
bool removeRecord (PVRecordPtr const &record)
 Remove a record. More...
 
epics::pvData::PVStringArrayPtr getRecordNames ()
 Get the names of all the records in the database. More...
 

Static Public Member Functions

static PVDatabasePtr getMaster ()
 Get the master database. More...
 

Friends

class PVRecord
 

Detailed Description

The interface for a database of PVRecords.

Author
mrk

Definition at line 504 of file pvDatabase.h.

Constructor & Destructor Documentation

◆ ~PVDatabase()

epics::pvDatabase::PVDatabase::~PVDatabase ( )
virtual

Destructor.

Definition at line 56 of file pvDatabase.cpp.

References DEBUG_LEVEL.

Member Function Documentation

◆ addRecord()

bool epics::pvDatabase::PVDatabase::addRecord ( PVRecordPtr const &  record)

Add a record.

Parameters
recordThe record to add.
Returns
true if record was added.

Definition at line 79 of file pvDatabase.cpp.

◆ findRecord()

PVRecordPtr epics::pvDatabase::PVDatabase::findRecord ( std::string const &  recordName)

Find a record. An empty pointer is returned if the record is not in the database.

Parameters
recordNameThe record to find.
Returns
The shared pointer.

Definition at line 69 of file pvDatabase.cpp.

◆ getMaster()

PVDatabasePtr epics::pvDatabase::PVDatabase::getMaster ( )
static

Get the master database.

Returns
The shared pointer.

Definition at line 38 of file pvDatabase.cpp.

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

◆ getRecordNames()

PVStringArrayPtr epics::pvDatabase::PVDatabase::getRecordNames ( )

Get the names of all the records in the database.

Returns
The names.

Definition at line 122 of file pvDatabase.cpp.

◆ POINTER_DEFINITIONS()

epics::pvDatabase::PVDatabase::POINTER_DEFINITIONS ( PVDatabase  )

◆ removeRecord()

bool epics::pvDatabase::PVDatabase::removeRecord ( PVRecordPtr const &  record)

Remove a record.

Parameters
recordThe record to remove.
Returns
true if record was removed.

Definition at line 108 of file pvDatabase.cpp.

Friends And Related Function Documentation

◆ PVRecord

friend class PVRecord
friend

Definition at line 543 of file pvDatabase.h.


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