org.epics.vtype

Interface VExtendedAlarm

All Superinterfaces:

VType

public interface VExtendedAlarm
extends VType

Extended alarm information. This supplements the alarm information given with scalar and array pvs, by showing all the possible alarm conditions specific to a device, and which ones are active at the moment.

The data type on the wire will look significantly different. The name and severity of each conditions don't typically change and are considered metadata. The actual alarm state (which ones are on or off) and the error message are what changes at each notification.

Author:

carcassi

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	VExtendedAlarm.AlarmCondition A single alarm condition that can be on or off.

Method Summary

Methods

Modifier and Type	Method and Description
List<VExtendedAlarm.AlarmCondition>	getConditions() All the possible alarm conditions for the device, and whether they are on or off.
String	getMessage() A human readable error message associated to the error(s).

Method Detail

getConditions

List<VExtendedAlarm.AlarmCondition> getConditions()

All the possible alarm conditions for the device, and whether they are on or off.

Returns:

the alarm conditions

getMessage

String getMessage()

A human readable error message associated to the error(s).

Returns:

a message or null