This is Unofficial EPICS BASE Doxygen Site
Public Member Functions | List of all members
epics::pvDatabase::PVSupport Class Referenceabstract

Base interface for a PVSupport. More...

#include "pvSupport.h"

+ Inheritance diagram for epics::pvDatabase::PVSupport:

Public Member Functions

 POINTER_DEFINITIONS (PVSupport)
 
virtual ~PVSupport ()
 
virtual bool init (epics::pvData::PVFieldPtr const &pvValue, epics::pvData::PVFieldPtr const &pvSupport)
 Optional initialization method. More...
 
virtual void start ()
 Optional method for derived class. More...
 
virtual bool process ()=0
 Virtual method for derived class. More...
 
virtual void reset ()
 Optional method for derived class. More...
 

Detailed Description

Base interface for a PVSupport.

Definition at line 32 of file pvSupport.h.

Constructor & Destructor Documentation

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

The Destructor.

Definition at line 39 of file pvSupport.h.

39 {}

Member Function Documentation

virtual bool epics::pvDatabase::PVSupport::init ( epics::pvData::PVFieldPtr const &  pvValue,
epics::pvData::PVFieldPtr const &  pvSupport 
)
inlinevirtual

Optional initialization method.

Called after PVRecord is created but before record is installed into PVDatabase.

Parameters
pvValueThe field to support.
pvSupportSupport specific fields.
Returns
true for success and false for failure.

Reimplemented in epics::pvDatabase::ControlSupport.

Definition at line 49 of file pvSupport.h.

51  {return true;}
epics::pvDatabase::PVSupport::POINTER_DEFINITIONS ( PVSupport  )
virtual bool epics::pvDatabase::PVSupport::process ( )
pure virtual

Virtual method for derived class.

Called when record is processed. It is the method that implements support. It is called each time the record is processed.

Returns
Returns true is any fields were modified; otherwise false.

Implemented in epics::pvDatabase::ScalarAlarmSupport, and epics::pvDatabase::ControlSupport.

virtual void epics::pvDatabase::PVSupport::reset ( )
inlinevirtual

Optional method for derived class.

Reimplemented in epics::pvDatabase::ScalarAlarmSupport, and epics::pvDatabase::ControlSupport.

Definition at line 72 of file pvSupport.h.

72 {};
virtual void epics::pvDatabase::PVSupport::start ( )
inlinevirtual

Optional method for derived class.

It is called before record is added to database.

Definition at line 57 of file pvSupport.h.

57 {}
The documentation for this class was generated from the following file: