pvDatabaseCPP  4.5.1
Public Member Functions | Static Public Member Functions | Private Member Functions | List of all members
epics::pvDatabase::ControlSupport Class Reference

Base interface for a ControlSupport. More...

#include <controlSupport.h>

Inheritance diagram for epics::pvDatabase::ControlSupport:
epics::pvDatabase::PVSupport

Public Member Functions

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

Static Public Member Functions

static ControlSupportPtr create (PVRecordPtr const &pvRecord)
 create a ControlSupport More...
 
static epics::pvData::StructureConstPtr controlField (epics::pvData::ScalarType scalarType)
 create a controlSupport required by ControlSupport More...
 

Private Member Functions

 POINTER_DEFINITIONS (PVSupport)
 
virtual void start ()
 Optional method for derived class. More...
 

Detailed Description

Base interface for a ControlSupport.

Definition at line 28 of file controlSupport.h.

Constructor & Destructor Documentation

◆ ~ControlSupport()

epics::pvDatabase::ControlSupport::~ControlSupport ( )
virtual

The Destructor.

Definition at line 30 of file controlSupport.cpp.

Member Function Documentation

◆ controlField()

epics::pvData::StructureConstPtr epics::pvDatabase::ControlSupport::controlField ( epics::pvData::ScalarType  scalarType)
static

create a controlSupport required by ControlSupport

Parameters
scalarTypeThe type for outputValue.
Returns
The controlField introspection structure.

Definition at line 35 of file controlSupport.cpp.

◆ create()

ControlSupportPtr epics::pvDatabase::ControlSupport::create ( PVRecordPtr const &  pvRecord)
static

create a ControlSupport

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

Definition at line 47 of file controlSupport.cpp.

◆ init()

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

Connects to contol fields.

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

Reimplemented from epics::pvDatabase::PVSupport.

Definition at line 57 of file controlSupport.cpp.

◆ POINTER_DEFINITIONS()

epics::pvDatabase::ControlSupport::POINTER_DEFINITIONS ( ControlSupport  )

◆ process()

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

Honors control fields.

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

Implements epics::pvDatabase::PVSupport.

Definition at line 90 of file controlSupport.cpp.

◆ reset()

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

If implementing minSteps it sets isMinStep to false.

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

Reimplemented from epics::pvDatabase::PVSupport.

Definition at line 131 of file controlSupport.cpp.


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