pt.up.fe.dceg.neptus.alarms

Class AlarmProviderImp

java.lang.Object

pt.up.fe.dceg.neptus.alarms.AlarmProviderImp

All Implemented Interfaces:

AlarmProvider

public class AlarmProviderImp
extends java.lang.Object
implements AlarmProvider

A simple implementation of a AlarmProvider meant to be used by components who are able to issue various alarms (see EntityStatePanel for an example). It is a basic implementation with a full constructor and a getter/setter for every field.

Author:

jqcorreia

Constructor Summary

Constructors

Constructor and Description
AlarmProviderImp(AlarmManager.AlarmLevel state, java.lang.String name, java.lang.String message)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAlarmMessage() Implement this method to return the current alarm message ( this messages are disassociated with the messages used in AlarmManager.postMessage(AlarmProvider, String, AlarmLevel) This message describes the present state of the alarm in a more verbose way
java.lang.String	getAlarmName() Method to return the alarm name.
AlarmManager.AlarmLevel	getAlarmState() Method to return the current alarm level of the provider
void	setMessage(java.lang.String message)
void	setName(java.lang.String name)
void	setState(AlarmManager.AlarmLevel state)

Methods inherited from class java.lang.Object

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

Constructor Detail

AlarmProviderImp

public AlarmProviderImp(AlarmManager.AlarmLevel state,
                        java.lang.String name,
                        java.lang.String message)

Method Detail

getAlarmState

public AlarmManager.AlarmLevel getAlarmState()

Description copied from interface: AlarmProvider

Method to return the current alarm level of the provider

Specified by:

getAlarmState in interface AlarmProvider

Returns:

the alarm state

getAlarmName

public java.lang.String getAlarmName()

Description copied from interface: AlarmProvider

Method to return the alarm name.

Specified by:

getAlarmName in interface AlarmProvider

Returns:

the alarm name

getAlarmMessage

public java.lang.String getAlarmMessage()

Description copied from interface: AlarmProvider

Implement this method to return the current alarm message ( this messages are disassociated with the messages used in AlarmManager.postMessage(AlarmProvider, String, AlarmLevel) This message describes the present state of the alarm in a more verbose way

Specified by:

getAlarmMessage in interface AlarmProvider

Returns:

the alarm message

setState

public void setState(AlarmManager.AlarmLevel state)

setName

public void setName(java.lang.String name)

setMessage

public void setMessage(java.lang.String message)