pvDatabaseCPP  4.5.3-dev
Public Member Functions | Protected Member Functions | Friends | List of all members
epics::pvDatabase::PVRecordField Class Reference

Interface for a field of a record. More...

#include <pvDatabase.h>

Inheritance diagram for epics::pvDatabase::PVRecordField:
epics::pvDatabase::PVRecordStructure

Public Member Functions

 POINTER_DEFINITIONS (PVRecordField)
 
 PVRecordField (epics::pvData::PVFieldPtr const &pvField, PVRecordStructurePtr const &parent, PVRecordPtr const &pvRecord)
 Constructor. More...
 
virtual ~PVRecordField ()
 Destructor. More...
 
PVRecordStructurePtr getParent ()
 Get the parent. More...
 
epics::pvData::PVFieldPtr getPVField ()
 Get the PVField. More...
 
std::string getFullFieldName ()
 Get the full name of the field, i.e. field,field,.. More...
 
std::string getFullName ()
 Get the recordName plus the full name of the field, i.e. recordName.field,field,.. More...
 
PVRecordPtr getPVRecord ()
 Return the PVRecord to which this field belongs. More...
 
virtual void postPut ()
 This is called by the code that implements the data interface. It is called whenever the put method is called. More...
 

Protected Member Functions

virtual void init ()
 
virtual void postParent (PVRecordFieldPtr const &subField)
 
virtual void postSubField ()
 

Friends

class PVRecordStructure
 
class PVRecord
 

Detailed Description

Interface for a field of a record.

One exists for each field of the top level PVStructure.

Author
mrk

Definition at line 286 of file pvDatabase.h.

Constructor & Destructor Documentation

◆ PVRecordField()

epics::pvDatabase::PVRecordField::PVRecordField ( epics::pvData::PVFieldPtr const &  pvField,
PVRecordStructurePtr const &  parent,
PVRecordPtr const &  pvRecord 
)

Constructor.

Parameters
pvFieldThe field from the top level structure.
parentThe parent.
pvRecordThe PVRecord.

Definition at line 323 of file pvRecord.cpp.

Referenced by epics::pvDatabase::PVRecordStructure::init().

◆ ~PVRecordField()

virtual epics::pvDatabase::PVRecordField::~PVRecordField ( )
inlinevirtual

Destructor.

Definition at line 306 of file pvDatabase.h.

Member Function Documentation

◆ getFullFieldName()

string epics::pvDatabase::PVRecordField::getFullFieldName ( )

Get the full name of the field, i.e. field,field,..

Returns
The full name.

Definition at line 362 of file pvRecord.cpp.

◆ getFullName()

string epics::pvDatabase::PVRecordField::getFullName ( )

Get the recordName plus the full name of the field, i.e. recordName.field,field,..

Returns
The name.

Definition at line 364 of file pvRecord.cpp.

Referenced by getPVRecord().

◆ getParent()

PVRecordStructurePtr epics::pvDatabase::PVRecordField::getParent ( )

Get the parent.

Returns
The parent.

Definition at line 355 of file pvRecord.cpp.

◆ getPVField()

PVFieldPtr epics::pvDatabase::PVRecordField::getPVField ( )

Get the PVField.

Returns
The shared pointer.

Definition at line 360 of file pvRecord.cpp.

◆ getPVRecord()

PVRecordPtr epics::pvDatabase::PVRecordField::getPVRecord ( )

Return the PVRecord to which this field belongs.

Returns
The shared pointer,

Definition at line 366 of file pvRecord.cpp.

References getFullName().

Referenced by epics::pvDatabase::PVRecordStructure::init().

◆ init()

void epics::pvDatabase::PVRecordField::init ( )
protectedvirtual

Reimplemented in epics::pvDatabase::PVRecordStructure.

Definition at line 334 of file pvRecord.cpp.

Referenced by epics::pvDatabase::PVRecordStructure::init().

◆ POINTER_DEFINITIONS()

epics::pvDatabase::PVRecordField::POINTER_DEFINITIONS ( PVRecordField  )

◆ postParent()

void epics::pvDatabase::PVRecordField::postParent ( PVRecordFieldPtr const &  subField)
protectedvirtual

Definition at line 404 of file pvRecord.cpp.

◆ postPut()

void epics::pvDatabase::PVRecordField::postPut ( )
virtual

This is called by the code that implements the data interface. It is called whenever the put method is called.

Definition at line 395 of file pvRecord.cpp.

References postSubField().

◆ postSubField()

void epics::pvDatabase::PVRecordField::postSubField ( )
protectedvirtual

Definition at line 418 of file pvRecord.cpp.

References epics::pvDatabase::PVRecordStructure::getPVRecordFields().

Referenced by postPut().

Friends And Related Function Documentation

◆ PVRecord

friend class PVRecord
friend

Definition at line 356 of file pvDatabase.h.

◆ PVRecordStructure

friend class PVRecordStructure
friend

Definition at line 355 of file pvDatabase.h.


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