org.epics.pvmanager.data
Interface Display

All Known Subinterfaces:

VByteArray, VDouble, VDoubleArray, VFloatArray, VInt, VIntArray, VMultiDouble, VMultiInt, VNumber, VNumberArray, VShortArray, VStatistics

public interface Display

Limit and unit information needed for display and control. The limits must be given in terms of the same type of the scalar type, which needs to be a number. The default for the ranges corresponds to the maximum range for the type.

Note: NumberFormats. If there is no direct write on metadata, number formats can be used to provide a default way to convert the value to a String.

Author:

carcassi

getLowerDisplayLimit

@Metadata
java.lang.Double getLowerDisplayLimit()

Lowest possible value to be displayed. Never null.

Returns:

lower display limit

getLowerCtrlLimit

@Metadata
java.lang.Double getLowerCtrlLimit()

Lowest possible value (included). Never null.

Returns:

lower limit

getLowerAlarmLimit

@Metadata
java.lang.Double getLowerAlarmLimit()

Lowest value before the alarm region. Never null.

Returns:

lower alarm limit

getLowerWarningLimit

@Metadata
java.lang.Double getLowerWarningLimit()

Lowest value before the warning region. Never null.

Returns:

lower warning limit

getUnits

@Metadata
java.lang.String getUnits()

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

Returns:

units

getFormat

@Metadata
java.text.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. If not yet connected, the format always returns an empty String.

Returns:

the default format for all values

getUpperWarningLimit

@Metadata
java.lang.Double getUpperWarningLimit()

Highest value before the warning region. Never null.

Returns:

upper warning limit

getUpperAlarmLimit

@Metadata
java.lang.Double getUpperAlarmLimit()

Highest value before the alarm region. Never null.

Returns:

upper alarm limit

getUpperCtrlLimit

@Metadata
java.lang.Double getUpperCtrlLimit()

Highest possible value (included). Never null.

Returns:

upper limit

getUpperDisplayLimit

@Metadata
java.lang.Double getUpperDisplayLimit()

Highest possible value to be displayed. Never null.

Returns:

upper display limit