Package org.yamcs.studio.data.vtype

Interface Display

All Known Subinterfaces:
VByte, VByteArray, VDouble, VDoubleArray, VFloat, VFloatArray, VInt, VIntArray, VLong, VLongArray, VMultiDouble, VMultiInt, VNumber, VNumberArray, VShort, VShortArray, VStatistics, VTimestamp
All Known Implementing Classes:
AggregateArrayVType, AggregateVType, ArrayArrayVType, BinaryVType, BooleanArrayVType, BooleanVType, DoubleArrayVType, DoubleVType, EnumeratedArrayVType, EnumeratedVType, FloatArrayVType, FloatVType, IVByte, IVByteArray, IVDouble, IVDoubleArray, IVFloat, IVFloatArray, IVInt, IVIntArray, IVLongArray, IVMultiDouble, IVNumberArray, IVNumeric, IVShort, IVShortArray, IVStatistics, Sint32ArrayVType, Sint32VType, Sint64ArrayVType, Sint64VType, StringArrayVType, StringVType, TimestampVType, Uint32ArrayVType, Uint32VType, Uint64ArrayVType, Uint64VType, YamcsVType
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.

  • Method Details

    • getLowerDisplayLimit

      Double getLowerDisplayLimit()
      Lowest possible value to be displayed. Never null.

    • getLowerCtrlLimit

      Double getLowerCtrlLimit()
      Lowest possible value (included). Never null.

    • getLowerAlarmLimit

      Double getLowerAlarmLimit()
      Lowest value before the alarm region. Never null.

    • getLowerWarningLimit

      Double getLowerWarningLimit()
      Lowest value before the warning region. Never null.

    • getUnits

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

    • 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.

    • getUpperAlarmLimit

      Double getUpperAlarmLimit()
      Highest value before the alarm region. Never null.

    • getUpperCtrlLimit

      Double getUpperCtrlLimit()
      Highest possible value (included). Never null.

    • getUpperDisplayLimit

      Double getUpperDisplayLimit()
      Highest possible value to be displayed. Never null.