Class PVDisplay¶

Defined in File pvDisplay.h

Class Documentation¶

class PVDisplay¶

Methods for accessing an display structure.

A display structure has the following fields:

structure
    double limitLow
    double limitHigh
    string description
    string format
    string units

This class can be attached to a display structure field of any PVData object. The methods provide access to the fields in the attached structure, via an instance of class Display. This class should not be extended.

Public Functions

inline PVDisplay()¶: Constructor

bool attach(PVFieldPtr const &pvField)¶

void detach()¶: Detach for pvField.

bool isAttached()¶

Is the PVDisplay attached to a pvField?

Returns: (false,true) (is not,is) attached to a pvField.

void get(Display &display) const¶

copy the display structure values to Display

Parameters: display – An instance of class Display
Throws: If – not attached to a pvField.

bool set(Display const &display)¶

copy the values from Display to the display structure.

Parameters: display – An instance of class Display
Throws: If – not attached to a pvField.
Returns: (false,true) if pvField (immutable, mutable)