Package org.yamcs.studio.data.vtype

Class IVMetadata

java.lang.Object
org.yamcs.studio.data.vtype.IVMetadata
All Implemented Interfaces:
Alarm, Time
Direct Known Subclasses:
IVBoolean, IVBooleanArray, IVEnum, IVEnumArray, IVImage, IVNumeric, IVString, IVStringArray
public class IVMetadata extends Object implements Alarm, Time
Partial implementation for numeric types.

  • Constructor Details

    • IVMetadata

      public IVMetadata(Alarm alarm, Time time)

  • Method Details

    • 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()
      Description copied from interface: Alarm
      A brief text representation of the highest currently active alarm. Never null.
      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