org.epics.vtype

Interface Time

All Known Subinterfaces:

VBoolean, VBooleanArray, VByte, VByteArray, VDouble, VDoubleArray, VEnum, VEnumArray, VFloat, VFloatArray, VInt, VIntArray, VLong, VLongArray, VMultiDouble, VMultiEnum, VMultiInt, VMultiString, VNumber, VNumberArray, VShort, VShortArray, VStatistics, VString, VStringArray

All Known Implementing Classes:

AlarmTimeDisplayExtractor, AlarmTimeExtractor, PVFieldNTHistogramToVIntArray, PVFieldNTHistogramToVLongArray, PVFieldNTHistogramToVShortArray, PVFieldNTMatrixToVDoubleArray, PVFieldToVBoolean, PVFieldToVBooleanArray, PVFieldToVByte, PVFieldToVByteArray, PVFieldToVDouble, PVFieldToVDoubleArray, PVFieldToVEnum, PVFieldToVFloat, PVFieldToVFloatArray, PVFieldToVInt, PVFieldToVIntArray, PVFieldToVLong, PVFieldToVLongArray, PVFieldToVShort, PVFieldToVShortArray, PVFieldToVStatistics, PVFieldToVString, PVFieldToVStringArray

public interface Time

Time information.

Author:

carcassi

Method Summary

Methods

Modifier and Type	Method and Description
org.epics.util.time.Timestamp	getTimestamp() The timestamp 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 Detail

getTimestamp

org.epics.util.time.Timestamp getTimestamp()

The timestamp 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.

Returns:

the timestamp

getTimeUserTag

Integer getTimeUserTag()

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

Returns:

the user tag

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