pvDatabaseCPP  4.5.2
Public Member Functions | Protected Member Functions | Friends | List of all members
epics::pvDatabase::PVRecordStructure Class Reference

Interface for a field that is a structure. More...

#include <pvDatabase.h>

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

Public Member Functions

 POINTER_DEFINITIONS (PVRecordStructure)
 
 PVRecordStructure (epics::pvData::PVStructurePtr const &pvStructure, PVRecordStructurePtr const &parent, PVRecordPtr const &pvRecord)
 Constructor. More...
 
virtual ~PVRecordStructure ()
 Destructor. More...
 
PVRecordFieldPtrArrayPtr getPVRecordFields ()
 Get the sub fields. More...
 
epics::pvData::PVStructurePtr getPVStructure ()
 Get the data structure/. More...
 
 POINTER_DEFINITIONS (PVRecordField)
 
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 ()
 Called by implementation code of PVRecord. More...
 
virtual void postParent (PVRecordFieldPtr const &subField)
 
virtual void postSubField ()
 

Friends

class PVRecord
 

Detailed Description

Interface for a field that is a structure.

One exists for each structure field of the top level PVStructure.

Author
mrk

Definition at line 365 of file pvDatabase.h.

Constructor & Destructor Documentation

◆ PVRecordStructure()

epics::pvDatabase::PVRecordStructure::PVRecordStructure ( epics::pvData::PVStructurePtr const &  pvStructure,
PVRecordStructurePtr const &  parent,
PVRecordPtr const &  pvRecord 
)

Constructor.

Parameters
pvStructureThe data.
parentThe parent
pvRecordThe record that has this field.

Definition at line 442 of file pvRecord.cpp.

Referenced by init().

◆ ~PVRecordStructure()

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

Destructor.

Definition at line 381 of file pvDatabase.h.

Member Function Documentation

◆ getFullFieldName()

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

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

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 epics::pvDatabase::PVRecordField::getPVRecord().

◆ getParent()

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

Get the parent.

Returns
The parent.

Definition at line 355 of file pvRecord.cpp.

◆ getPVField()

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

Get the PVField.

Returns
The shared pointer.

Definition at line 360 of file pvRecord.cpp.

◆ getPVRecord()

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

Return the PVRecord to which this field belongs.

Returns
The shared pointer,

Definition at line 366 of file pvRecord.cpp.

References epics::pvDatabase::PVRecordField::getFullName().

Referenced by init().

◆ getPVRecordFields()

PVRecordFieldPtrArrayPtr epics::pvDatabase::PVRecordStructure::getPVRecordFields ( )

Get the sub fields.

Returns
the array of PVRecordFieldPtr.

Definition at line 479 of file pvRecord.cpp.

Referenced by epics::pvDatabase::PVRecordField::postSubField().

◆ getPVStructure()

PVStructurePtr epics::pvDatabase::PVRecordStructure::getPVStructure ( )

Get the data structure/.

Returns
The shared pointer.

Definition at line 484 of file pvRecord.cpp.

◆ init()

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

◆ POINTER_DEFINITIONS() [1/2]

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

◆ POINTER_DEFINITIONS() [2/2]

epics::pvDatabase::PVRecordStructure::POINTER_DEFINITIONS ( PVRecordStructure  )

◆ postParent()

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

Definition at line 404 of file pvRecord.cpp.

◆ postPut()

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

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 epics::pvDatabase::PVRecordField::postSubField().

◆ postSubField()

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

Definition at line 418 of file pvRecord.cpp.

References getPVRecordFields().

Referenced by epics::pvDatabase::PVRecordField::postPut().

Friends And Related Function Documentation

◆ PVRecord

friend class PVRecord
friend

Definition at line 400 of file pvDatabase.h.


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