org.epics.vtype

Interface Display

All Known Subinterfaces:

VByte, VByteArray, VDouble, VDoubleArray, VFloat, VFloatArray, VInt, VIntArray, VLong, VLongArray, VMultiDouble, VMultiInt, VNumber, VNumberArray, VShort, VShortArray, VStatistics

All Known Implementing Classes:

AlarmTimeDisplayExtractor, PVFieldNTHistogramToVIntArray, PVFieldNTHistogramToVLongArray, PVFieldNTHistogramToVShortArray, PVFieldNTMatrixToVDoubleArray, PVFieldToVBoolean, PVFieldToVBooleanArray, PVFieldToVByte, PVFieldToVByteArray, PVFieldToVDouble, PVFieldToVDoubleArray, PVFieldToVFloat, PVFieldToVFloatArray, PVFieldToVInt, PVFieldToVIntArray, PVFieldToVLong, PVFieldToVLongArray, PVFieldToVShort, PVFieldToVShortArray, PVFieldToVStatistics, PVFieldToVString, PVFieldToVStringArray

public interface Display

Limit and unit information needed for display and control.

The numeric limits are given in double precision no matter which numeric type. The unit is a simple String, which can be empty if no unit information is provided. The number format can be used to convert the value to a String.

Author:

carcassi

Method Summary

Methods

Modifier and Type	Method and Description
NumberFormat	getFormat() Returns a NumberFormat that creates a String with just the value (no units).
Double	getLowerAlarmLimit() Lowest value before the alarm region.
Double	getLowerCtrlLimit() Lowest possible value (included).
Double	getLowerDisplayLimit() Lowest possible value to be displayed.
Double	getLowerWarningLimit() Lowest value before the warning region.
String	getUnits() String representation of the units using for all values.
Double	getUpperAlarmLimit() Highest value before the alarm region.
Double	getUpperCtrlLimit() Highest possible value (included).
Double	getUpperDisplayLimit() Highest possible value to be displayed.
Double	getUpperWarningLimit() Highest value before the warning region.

Method Detail

getLowerDisplayLimit

Double getLowerDisplayLimit()

Lowest possible value to be displayed. Never null.

Returns:

lower display limit

getLowerCtrlLimit

Double getLowerCtrlLimit()

Lowest possible value (included). Never null.

Returns:

lower limit

getLowerAlarmLimit

Double getLowerAlarmLimit()

Lowest value before the alarm region. Never null.

Returns:

lower alarm limit

getLowerWarningLimit

Double getLowerWarningLimit()

Lowest value before the warning region. Never null.

Returns:

lower warning limit

getUnits

String getUnits()

String representation of the units using for all values. Never null. If not available, returns the empty String.

Returns:

units

getFormat

NumberFormat getFormat()

Returns a NumberFormat that creates a String with just the value (no units). Format is locale independent and should be used for all values (values and lower/upper limits). Never null.

Returns:

the default format for all values

getUpperWarningLimit

Double getUpperWarningLimit()

Highest value before the warning region. Never null.

Returns:

upper warning limit

getUpperAlarmLimit

Double getUpperAlarmLimit()

Highest value before the alarm region. Never null.

Returns:

upper alarm limit

getUpperCtrlLimit

Double getUpperCtrlLimit()

Highest possible value (included). Never null.

Returns:

upper limit

getUpperDisplayLimit

Double getUpperDisplayLimit()

Highest possible value to be displayed. Never null.

Returns:

upper display limit