org.epics.vtype

Interface Alarm

All Known Subinterfaces:

VBoolean, VBooleanArray, VByte, VByteArray, VDouble, VDoubleArray, VEnum, VEnumArray, VExtendedAlarm.AlarmCondition, 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 Alarm

Alarm information. Represents the severity and name of the highest alarm associated with the channel.

Author:

carcassi

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.

Method Detail

getAlarmSeverity

AlarmSeverity getAlarmSeverity()

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

Returns:

the alarm severity

getAlarmName

String getAlarmName()

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

Returns:

the alarm status