Package org.yamcs.studio.data.vtype

Interface Time

All Known Subinterfaces:
VBoolean, VBooleanArray, VByte, VByteArray, VDouble, VDoubleArray, VEnum, VEnumArray, VFloat, VFloatArray, VImage, VInt, VIntArray, VLong, VLongArray, VMultiDouble, VMultiEnum, VMultiInt, VMultiString, VNumber, VNumberArray, VShort, VShortArray, VStatistics, VString, VStringArray, VTimestamp
All Known Implementing Classes:
AggregateArrayVType, AggregateVType, ArrayArrayVType, BinaryVType, BooleanArrayVType, BooleanVType, DoubleArrayVType, DoubleVType, EnumeratedArrayVType, EnumeratedVType, FloatArrayVType, FloatVType, IVBoolean, IVBooleanArray, IVByte, IVByteArray, IVDouble, IVDoubleArray, IVEnum, IVEnumArray, IVFloat, IVFloatArray, IVImage, IVInt, IVIntArray, IVLongArray, IVMetadata, IVMultiDouble, IVNumberArray, IVNumeric, IVShort, IVShortArray, IVStatistics, IVString, IVStringArray, Sint32ArrayVType, Sint32VType, Sint64ArrayVType, Sint64VType, StringArrayVType, StringVType, TimestampVType, Uint32ArrayVType, Uint32VType, Uint64ArrayVType, Uint64VType, YamcsVType
public interface Time
Time information.

  • Method Summary

    Modifier and Type
    Method
    Description
    Instant
    getTimestamp()
    The time instant of the value, typically indicating when it was generated.
    Integer
    getTimeUserTag()
    Returns a user defined tag, that can be used to store extra time information, such as beam shot.
    boolean
    isTimeValid()
    Returns a data source specific flag to indicate whether the time information should be trusted.

  • Method Details

    • getTimestamp

      Instant getTimestamp()
      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.

    • getTimeUserTag

      Integer getTimeUserTag()
      Returns a user defined tag, that can be used to store extra time information, such as beam shot.

    • isTimeValid

      boolean isTimeValid()
      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.
      Returns:
      true if the time information is valid