Class Display¶

Defined in File display.h

Class Documentation¶

class Display¶

Methods for a display structure.

An display structure has the following fields:

structure
    double limitLow
    double limitHigh
    string description
    string format
    string units

This is a class that holds values corresponding to the fields in a display structure. It is meant to be used together with pvDisplay which allows values to be copied between an display structure and this class. This class should not be extended.

Public Functions

inline Display()¶: Constructor

inline double getLow() const¶

Get the current value of limitLow.

Returns: The current value.

inline double getHigh() const¶

Get the current value of limitHigh.

Returns: The current value.

inline void setLow(double value)¶

Set limitLow to a new value.

Parameters: value – The value.

inline void setHigh(double value)¶

Set limitHigh to a new value.

Parameters: value – The value.

inline std::string getDescription() const¶

Get the current value of description.

Returns: The current value.

inline void setDescription(std::string const &value)¶

Set description to a new value.

Parameters: value – The value.

inline std::string getFormat() const¶

Get the current value of format.

Returns: The current value.

inline void setFormat(std::string const &value)¶

Set format to a new value.

Parameters: value – The value. The rules for a valid syntax has not been specified.

inline std::string getUnits() const¶

Get the current value of units.

Returns: The current value.

inline void setUnits(std::string const &value)¶

Set units to a new value.

Parameters: value – The value.