epics::pvData::Display Class Reference

Methods for a display structure. More...

#include "display.h"

Public Member Functions
	Display ()
double	getLow () const
double	getHigh () const
void	setLow (double value)
void	setHigh (double value)
std::string	getDescription () const
void	setDescription (std::string const &value)
std::string	getFormat () const
void	setFormat (std::string const &value)
std::string	getUnits () const
void	setUnits (std::string const &value)

Detailed Description

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.

Definition at line 39 of file display.h.

Constructor & Destructor Documentation

epics::pvData::Display::Display ( )

inline

Constructor

Definition at line 44 of file display.h.

    : description(std::string("")),format(std::string("")),units(std::string("")),
        low(0.0),high(0.0) {}

Member Function Documentation

std::string epics::pvData::Display::getDescription ( ) const

inline

Get the current value of description.

Returns

The current value.

Definition at line 72 of file display.h.

{return description;}

std::string epics::pvData::Display::getFormat ( ) const

inline

Get the current value of format.

Returns

The current value.

Definition at line 82 of file display.h.

{return format;}

double epics::pvData::Display::getHigh ( ) const

inline

Get the current value of limitHigh.

Returns

The current value.

Definition at line 57 of file display.h.

{ return high;}

double epics::pvData::Display::getLow ( ) const

inline

Get the current value of limitLow.

Returns

The current value.

Definition at line 52 of file display.h.

{return low;}

std::string epics::pvData::Display::getUnits ( ) const

inline

Get the current value of units.

Returns

The current value.

Definition at line 93 of file display.h.

{return units;}

void epics::pvData::Display::setDescription ( std::string const &  value )

inline

Set description to a new value.

Parameters

value

The value.

Definition at line 77 of file display.h.

{description = value;}

void epics::pvData::Display::setFormat ( std::string const &  value )

inline

Set format to a new value.

Parameters

value

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

Definition at line 88 of file display.h.

{format = value;}

void epics::pvData::Display::setHigh ( double  value )

inline

Set limitHigh to a new value.

Parameters

value

The value.

Definition at line 67 of file display.h.

{high = value;}

void epics::pvData::Display::setLow ( double  value )

inline

Set limitLow to a new value.

Parameters

value

The value.

Definition at line 62 of file display.h.

{low = value;}

void epics::pvData::Display::setUnits ( std::string const &  value )

inline

Set units to a new value.

Parameters

value

The value.

Definition at line 98 of file display.h.

{units = value;}

---

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

• modules/pvData/src/property/pv/display.h