Package org.epics.pvdata.property

Class Alarm

java.lang.Object

org.epics.pvdata.property.Alarm

public final class Alarm
extends Object

Convenience class for an alarm.

Author:

mrk

Constructor Summary

Constructors

Constructor	Description
Alarm()	Constructor

Method Summary

Modifier and Type	Method	Description
String	getMessage()	Get the alarm message.
AlarmSeverity	getSeverity()	Get the alarm severity.
AlarmStatus	getStatus()	Get the alarm status.
void	setMessage(String message)	Set the alarm message.
void	setSeverity(AlarmSeverity alarmSeverity)	Set the alarm severity.
void	setStatus(AlarmStatus alarmStatus)	Set the alarm status.

Methods inherited from class java.lang.Object

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

Constructor Detail

Alarm

public Alarm()

Constructor

Method Detail

getMessage

public String getMessage()

Get the alarm message.

Returns:

the value

setMessage

public void setMessage(String message)

Set the alarm message.

Parameters:

message - the message

getSeverity

public AlarmSeverity getSeverity()

Get the alarm severity.

Returns:

the value

setSeverity

public void setSeverity(AlarmSeverity alarmSeverity)

Set the alarm severity. If an invalid value is given than an exception is thrown.

Parameters:

alarmSeverity - the severity

getStatus

public AlarmStatus getStatus()

Get the alarm status.

Returns:

the value

setStatus

public void setStatus(AlarmStatus alarmStatus)

Set the alarm status. If an invalid value is given than an exception is thrown.

Parameters:

alarmStatus - the status