pvDatabaseCPP  4.5.3-dev
Public Member Functions | Static Public Member Functions | Private Member Functions | List of all members
epics::pvDatabase::ScalarAlarmSupport Class Reference

Base interface for a ScalarAlarmSupport. More...

#include <scalarAlarmSupport.h>

Inheritance diagram for epics::pvDatabase::ScalarAlarmSupport:
epics::pvDatabase::PVSupport

Public Member Functions

 POINTER_DEFINITIONS (ScalarAlarmSupport)
 
virtual ~ScalarAlarmSupport ()
 
virtual bool init (epics::pvData::PVFieldPtr const &pvValue, epics::pvData::PVStructurePtr const &pvAlarm, epics::pvData::PVFieldPtr const &pvSupport)
 Connects to contol fields. More...
 
virtual bool process ()
 Honors scalarAlarm fields. More...
 
virtual void reset ()
 If implementing minSteps it sets isMinStep to false. More...
 

Static Public Member Functions

static ScalarAlarmSupportPtr create (PVRecordPtr const &pvRecord)
 create a ScalarAlarm More...
 
static epics::pvData::StructureConstPtr scalarAlarmField ()
 create a scalarAlarm required by ScalarAlarm More...
 

Private Member Functions

 POINTER_DEFINITIONS (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...
 

Detailed Description

Base interface for a ScalarAlarmSupport.

Definition at line 31 of file scalarAlarmSupport.h.

Constructor & Destructor Documentation

◆ ~ScalarAlarmSupport()

epics::pvDatabase::ScalarAlarmSupport::~ScalarAlarmSupport ( )
virtual

The Destructor.

Definition at line 31 of file scalarAlarmSupport.cpp.

Member Function Documentation

◆ create()

ScalarAlarmSupportPtr epics::pvDatabase::ScalarAlarmSupport::create ( PVRecordPtr const &  pvRecord)
static

create a ScalarAlarm

Parameters
pvRecord- The pvRecord to which the support is attached.
Returns
The new ScalarAlarm

Definition at line 49 of file scalarAlarmSupport.cpp.

◆ init()

bool epics::pvDatabase::ScalarAlarmSupport::init ( epics::pvData::PVFieldPtr const &  pvValue,
epics::pvData::PVStructurePtr const &  pvAlarm,
epics::pvData::PVFieldPtr const &  pvSupport 
)
virtual

Connects to contol fields.

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

Definition at line 61 of file scalarAlarmSupport.cpp.

◆ POINTER_DEFINITIONS()

epics::pvDatabase::ScalarAlarmSupport::POINTER_DEFINITIONS ( ScalarAlarmSupport  )

◆ process()

bool epics::pvDatabase::ScalarAlarmSupport::process ( )
virtual

Honors scalarAlarm fields.

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

Implements epics::pvDatabase::PVSupport.

Definition at line 103 of file scalarAlarmSupport.cpp.

◆ reset()

void epics::pvDatabase::ScalarAlarmSupport::reset ( )
virtual

If implementing minSteps it sets isMinStep to false.

Reimplemented from epics::pvDatabase::PVSupport.

Definition at line 141 of file scalarAlarmSupport.cpp.

◆ scalarAlarmField()

epics::pvData::StructureConstPtr epics::pvDatabase::ScalarAlarmSupport::scalarAlarmField ( )
static

create a scalarAlarm required by ScalarAlarm

Returns
The scalarAlarmField introspection structure.

Definition at line 37 of file scalarAlarmSupport.cpp.


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