org.epics.pvmanager.data
Interface Alarm

All Known Subinterfaces:
VDouble, VDoubleArray, VEnum, VEnumArray, VInt, VIntArray, VMultiDouble, VMultiEnum, VMultiInt, VMultiString, VStatistics, VString, VStringArray

public interface Alarm

Alarm information.

The alarm status is represented by a set of status bits that could be either set or unset. This is implemented in Java by the use of Sets.

Author:
carcassi

Method Summary
 AlarmSeverity getAlarmSeverity()
          Returns the alarm severity, which describes the quality of the value returned.
 java.util.Set<java.lang.String> getAlarmStatus()
          Returns the set of alarm statuses that are currently active.
 java.util.List<java.lang.String> getPossibleAlarms()
          Defines all possible alarm statuses that are valid on this channel.
 

Method Detail

getAlarmSeverity

AlarmSeverity getAlarmSeverity()
Returns the alarm severity, which describes the quality of the value returned. Never null.

Returns:
the alarm severity

getAlarmStatus

java.util.Set<java.lang.String> getAlarmStatus()
Returns the set of alarm statuses that are currently active. Never null.

Returns:
a set of enabled alarms

getPossibleAlarms

@Metadata
java.util.List<java.lang.String> getPossibleAlarms()
Defines all possible alarm statuses that are valid on this channel. Never null; if not connected returns an empty list. In Epics 3, this list is going to be the same for all PVs. In Epics V, this list is going to be possibly different for each channel, but the common lists for client/server pairs should be cached.

Returns:
a set of labels


Copyright © 2010. All Rights Reserved.