org.epics.pvmanager.pva.adapters

Class AlarmTimeExtractor

java.lang.Object

org.epics.pvmanager.pva.adapters.AlarmTimeExtractor

All Implemented Interfaces:

Alarm, Time

Direct Known Subclasses:

AlarmTimeDisplayExtractor, PVFieldToVEnum

public class AlarmTimeExtractor
extends Object
implements Alarm, Time

Field Summary

Fields

Modifier and Type	Field and Description
protected AlarmSeverity	alarmSeverity
protected static AlarmSeverity[]	alarmSeverityMapLUT
protected String	alarmStatus
protected static String[]	alarmStatusMapLUT
protected boolean	isTimeValid
protected org.epics.util.time.Timestamp	timeStamp
protected Integer	timeUserTag

Constructor Summary

Constructors

Constructor and Description
AlarmTimeExtractor(org.epics.pvdata.pv.PVStructure pvField, boolean disconnected)

Method Summary

Methods

Modifier and Type	Method and Description
String	getAlarmName() Returns a brief text representation of the highest currently active alarm.
AlarmSeverity	getAlarmSeverity() Returns the alarm severity, which describes the quality of the value returned.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

alarmSeverity

protected final AlarmSeverity alarmSeverity

alarmStatus

protected final String alarmStatus

timeStamp

protected final org.epics.util.time.Timestamp timeStamp

timeUserTag

protected final Integer timeUserTag

isTimeValid

protected final boolean isTimeValid

alarmSeverityMapLUT

protected static final AlarmSeverity[] alarmSeverityMapLUT

alarmStatusMapLUT

protected static final String[] alarmStatusMapLUT

Constructor Detail

AlarmTimeExtractor

public AlarmTimeExtractor(org.epics.pvdata.pv.PVStructure pvField,
                  boolean disconnected)

Method Detail

getAlarmSeverity

public AlarmSeverity getAlarmSeverity()

Description copied from interface: Alarm

Returns the alarm severity, which describes the quality of the value returned. Never null.

Specified by:

getAlarmSeverity in interface Alarm

Returns:

the alarm severity

getAlarmName

public String getAlarmName()

Description copied from interface: Alarm

Returns a brief text representation of the highest currently active alarm. Never null.

Specified by:

getAlarmName in interface Alarm

Returns:

the alarm status

getTimestamp

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

Description copied from interface: Time

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.

Specified by:

getTimestamp in interface Time

Returns:

the timestamp

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

Returns:

the user tag

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