public final class AlarmControl
extends java.lang.Object
Constructor and Description |
---|
AlarmControl(IEDeviceGroup devices_,
float alarmValue_,
de.desy.mst.auxiliary.devl.deviceserverlib.alarms.Alarm alarm_)
Constructor.
|
AlarmControl(IEDeviceGroup devices_,
float alarmValue_,
int maxCounter_,
de.desy.mst.auxiliary.devl.deviceserverlib.alarms.Alarm alarm_)
Constructor.
|
AlarmControl(IEDeviceGroup devices_,
float alarmValue_,
int maxCounter_,
de.desy.mst.auxiliary.devl.deviceserverlib.alarms.Alarm alarm_,
boolean retrieveAlarm_)
Constructor.
|
AlarmControl(int maxCounter_,
de.desy.mst.auxiliary.devl.deviceserverlib.alarms.Alarm alarm_)
The minimal
AlarmControl constructor. |
Modifier and Type | Method and Description |
---|---|
de.desy.mst.auxiliary.devl.deviceserverlib.alarms.Alarm |
getAlarm()
Alarm.
|
float |
getAlarmValue()
The alarm on which the error should occur.
|
int |
getDelay()
Returns the delay time of the TINE link.
|
IEDeviceGroup |
getDeviceGroup()
Returns the device group.
|
int |
getMaxCounter()
Returns the maximum counter.
|
void |
incrementCounter()
Increments the counter.
|
boolean |
isExceeded()
Requests if the internal counter is greater then the maximum counter.
|
boolean |
isRetrieveAlarm()
Requests if this alarm is retrieved (i.e.
|
void |
resetCounter()
Resets the current counter to 0.
|
java.lang.String |
toString() |
public AlarmControl(int maxCounter_, de.desy.mst.auxiliary.devl.deviceserverlib.alarms.Alarm alarm_)
AlarmControl
constructor. Only takes two arguments
and sets the rest to their default values.maxCounter_
- Maximum counter. Can also be 0, so it must be fired
immediately.alarm_
- The alarm which is for example send to the alarm
server.public AlarmControl(IEDeviceGroup devices_, float alarmValue_, de.desy.mst.auxiliary.devl.deviceserverlib.alarms.Alarm alarm_)
devices_
- Device group.alarmValue_
- Alarm value which causes the alarm.alarm_
- The alarm which is for example send to the alarm
server.public AlarmControl(IEDeviceGroup devices_, float alarmValue_, int maxCounter_, de.desy.mst.auxiliary.devl.deviceserverlib.alarms.Alarm alarm_, boolean retrieveAlarm_)
devices_
- Device group.alarmValue_
- Alarm value which causes the alarm.maxCounter_
- Maximum counter.alarm_
- The alarm which is for example send to the alarm
server.retrieveAlarm_
- The alarm can also be disabled by setting this
value to false
.public AlarmControl(IEDeviceGroup devices_, float alarmValue_, int maxCounter_, de.desy.mst.auxiliary.devl.deviceserverlib.alarms.Alarm alarm_)
devices_
- Device group.alarmValue_
- Alarm value which causes the alarm.maxCounter_
- Maximum counter.alarm_
- The alarm which is for example send to the alarm
server.public final IEDeviceGroup getDeviceGroup()
public final float getAlarmValue()
public final int getMaxCounter()
public final void incrementCounter()
public final void resetCounter()
public final boolean isExceeded()
true
if the counter exceeds the maximum
counter.public final boolean isRetrieveAlarm()
false
if this alarm is disabled, otherwise a
true
is returned.public final de.desy.mst.auxiliary.devl.deviceserverlib.alarms.Alarm getAlarm()
public final int getDelay()
public java.lang.String toString()
toString
in class java.lang.Object
14-September-2016 18:23 Deutsches Elektronen-Synchrotron DESY in der Helmholtz-Gemeinschaft