Package org.yamcs.studio.data.yamcs

Class YamcsVType

java.lang.Object
org.yamcs.studio.data.yamcs.YamcsVType
All Implemented Interfaces:
Alarm, Display, Time, VType
Direct Known Subclasses:
AggregateArrayVType, AggregateVType, ArrayArrayVType, BinaryVType, BooleanArrayVType, BooleanVType, DoubleArrayVType, DoubleVType, EnumeratedArrayVType, EnumeratedVType, FloatArrayVType, FloatVType, Sint32ArrayVType, Sint32VType, Sint64ArrayVType, Sint64VType, StringArrayVType, StringVType, TimestampVType, Uint32ArrayVType, Uint32VType, Uint64ArrayVType, Uint64VType
public class YamcsVType extends Object implements VType, Alarm, Time, Display

  • Field Details

  • Constructor Details

  • Method Details

    • getId

      public Yamcs.NamedObjectId getId()

    • getParameterValue

      public Pvalue.ParameterValue getParameterValue()

    • getAlarmSeverity

      public AlarmSeverity getAlarmSeverity()
      Description copied from interface: Alarm
      Describes the quality of the value returned. Never null.
      Specified by:
      getAlarmSeverity in interface Alarm

    • getAlarmName

      public String getAlarmName()
      Return similar values as in ValueFactory.newAlarm(Number, Display)
      Specified by:
      getAlarmName in interface Alarm

    • getTimestamp

      public Instant getTimestamp()
      Description copied from interface: Time
      The time instant of the value, typically indicating when it was generated. If never connected, it returns the time when it was last determined that no connection was made.
      Specified by:
      getTimestamp in interface Time

    • getTimeUserTag

      public Integer getTimeUserTag()
      Description copied from interface: Time
      Returns a user defined tag, that can be used to store extra time information, such as beam shot.
      Specified by:
      getTimeUserTag in interface Time

    • isTimeValid

      public boolean isTimeValid()
      Description copied from interface: Time
      Returns a data source specific flag to indicate whether the time information should be trusted. Typical cases are when records were not processes and the timestamp has a zero time.
      Specified by:
      isTimeValid in interface Time
      Returns:
      true if the time information is valid

    • getLowerWarningLimit

      public Double getLowerWarningLimit()
      Description copied from interface: Display
      Lowest value before the warning region. Never null.
      Specified by:
      getLowerWarningLimit in interface Display

    • getUpperWarningLimit

      public Double getUpperWarningLimit()
      Highest value before the warning region
      Specified by:
      getUpperWarningLimit in interface Display

    • getLowerAlarmLimit

      public Double getLowerAlarmLimit()
      Description copied from interface: Display
      Lowest value before the alarm region. Never null.
      Specified by:
      getLowerAlarmLimit in interface Display

    • getUpperAlarmLimit

      public Double getUpperAlarmLimit()
      Highest value before the alarm region
      Specified by:
      getUpperAlarmLimit in interface Display

    • getLowerDisplayLimit

      public Double getLowerDisplayLimit()
      Description copied from interface: Display
      Lowest possible value to be displayed. Never null.
      Specified by:
      getLowerDisplayLimit in interface Display

    • getUpperDisplayLimit

      public Double getUpperDisplayLimit()
      Description copied from interface: Display
      Highest possible value to be displayed. Never null.
      Specified by:
      getUpperDisplayLimit in interface Display

    • getLowerCtrlLimit

      public Double getLowerCtrlLimit()
      Description copied from interface: Display
      Lowest possible value (included). Never null.
      Specified by:
      getLowerCtrlLimit in interface Display

    • getUpperCtrlLimit

      public Double getUpperCtrlLimit()
      Description copied from interface: Display
      Highest possible value (included). Never null.
      Specified by:
      getUpperCtrlLimit in interface Display

    • getUnits

      public String getUnits()
      Description copied from interface: Display
      String representation of the units using for all values. Never null. If not available, returns the empty String.
      Specified by:
      getUnits in interface Display

    • getFormat

      public NumberFormat getFormat()
      Description copied from interface: Display
      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.
      Specified by:
      getFormat in interface Display
      Returns:
      the default format for all values

    • fromYamcs

      public static YamcsVType fromYamcs(Pvalue.ParameterValue pval, boolean raw)
      Converts a yamcs ParameterValue to a VType.