|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AlarmModel
Definition of the behaviour of the alarm model.
The AlarmModel is basically the state machine of the AlarmPoint system,
and it is possible to define different AlarmModel
s
for each and every alarm. Alarms that are assigned the default
AlarmModel
of the AlarmSystem
can be
re-assigned another AlarmModel
in runtime, just by
changing the default AlarmModel
in the
AlarmSystem
. Alarms can also change the
AlarmModel
by calling the setAlarmModel
in each alarm individually.
AlarmSystem
Field Summary | |
---|---|
static java.lang.String |
MODEL_BUNDLE_NAME
|
Method Summary | |
---|---|
java.util.List<java.lang.String> |
alarmTriggers()
Returns an array of alarm triggers valid for this AlarmModel. |
boolean |
computeCondition(AlarmStatus status)
|
java.lang.String |
computeTrigger(AlarmStatus status,
boolean condition)
|
AlarmEvent |
evaluate(AlarmPoint alarm,
java.lang.String trigger)
Execute the required changes upon an AlarmTrigger. |
java.lang.String |
modelDescription()
Returns a Description of the AlarmModel in the default Locale. |
java.lang.String |
modelDescription(java.util.Locale locale)
Returns a Description of the AlarmModel. |
java.lang.String |
modelName()
Returns the Name of the AlarmModel. |
java.util.List<java.lang.String> |
statusList()
|
Field Detail |
---|
static final java.lang.String MODEL_BUNDLE_NAME
Method Detail |
---|
AlarmEvent evaluate(AlarmPoint alarm, java.lang.String trigger) throws java.lang.IllegalArgumentException
alarm
- The AlarmPoint the trigger is for.trigger
- the AlarmTrigger that was used.
java.lang.IllegalArgumentException
- If the trigger given is not supported by this alarm model.java.util.List<java.lang.String> statusList()
java.util.List<java.lang.String> alarmTriggers()
java.lang.String computeTrigger(AlarmStatus status, boolean condition)
boolean computeCondition(AlarmStatus status)
java.lang.String modelName()
java.lang.String modelDescription()
java.lang.String modelDescription(@Optional java.util.Locale locale)
null
, then the
default Locale is used.
locale
- The locale that should be used for the description, or null for the default locale.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |