public final class ChannelAccessAlarmStatus extends Object
Channel Access alarm status codes. The status codes are used to signal the
cause of an alarm over the network. The forAlarmStatusCode(short)
method can be used to convert a status code that has been sent over the
network as a short integer.
Some alarm status codes have a predefined name and meaning. This name can be
retrieved using the toString()
method. For an alarm status without a
predefined meaning, the string "ALARM_###" is returned, where "###" is the
status code (interpreted as an unsigned number).
Modifier and Type | Field and Description |
---|---|
static ChannelAccessAlarmStatus |
BAD_SUB
Record alarm indicating that no subroutine has been set or the configured
subroutine is invalid.
|
static ChannelAccessAlarmStatus |
CALC
Calculation failed.
|
static ChannelAccessAlarmStatus |
COMM
Device support signaled a communication problem.
|
static ChannelAccessAlarmStatus |
COS
Value had a change of state that signals an alarm condition.
|
static ChannelAccessAlarmStatus |
DISABLE
Alarm raised when a record has been disabled and it is configured to
raise an alarm in this case.
|
static ChannelAccessAlarmStatus |
HIGH
Value is above upper warning limit.
|
static ChannelAccessAlarmStatus |
HIHI
Value is above upper alarm limit.
|
static ChannelAccessAlarmStatus |
HWLIMIT
Device support signaled that a hardware limit alarm has been triggered.
|
static ChannelAccessAlarmStatus |
LINK
Record link could not be processed.
|
static ChannelAccessAlarmStatus |
LOLO
Value is below lower alarm limit.
|
static ChannelAccessAlarmStatus |
LOW
Value is below lower warning limit.
|
static ChannelAccessAlarmStatus |
NO_ALARM
No alarm (everything is OK).
|
static ChannelAccessAlarmStatus |
READ
Error while trying to read a value.
|
static ChannelAccessAlarmStatus |
READ_ACCESS
Read access error.
|
static ChannelAccessAlarmStatus |
SCAN
Record could not be processed repeatedly because it is locked.
|
static ChannelAccessAlarmStatus |
SIMM
Simulated alarm.
|
static ChannelAccessAlarmStatus |
SOFT
Record soft alarm.
|
static ChannelAccessAlarmStatus |
STATE
Value represents a state that is an alarm condition.
|
static ChannelAccessAlarmStatus |
TIMEOUT
Device support signaled that an asynchronous device timed out.
|
static ChannelAccessAlarmStatus |
UDF
Value is undefined.
|
static ChannelAccessAlarmStatus |
WRITE
Error while trying to write a value.
|
static ChannelAccessAlarmStatus |
WRITE_ACCESS
Write access error.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj)
Tells whether the specified object represents the same alarm-status
object.
|
static ChannelAccessAlarmStatus |
forAlarmStatusCode(short statusCode)
Returns the alarm status for the given
statusCode . |
int |
hashCode()
Returns a hash code value for this alarm-status object.
|
short |
toAlarmStatusCode()
Returns the status code associated with this alarm status.
|
String |
toString()
Returns a string representation of this alarm-status object.
|
public static final ChannelAccessAlarmStatus NO_ALARM
public static final ChannelAccessAlarmStatus READ
public static final ChannelAccessAlarmStatus WRITE
public static final ChannelAccessAlarmStatus HIHI
public static final ChannelAccessAlarmStatus HIGH
public static final ChannelAccessAlarmStatus LOLO
public static final ChannelAccessAlarmStatus LOW
public static final ChannelAccessAlarmStatus STATE
public static final ChannelAccessAlarmStatus COS
public static final ChannelAccessAlarmStatus COMM
public static final ChannelAccessAlarmStatus TIMEOUT
public static final ChannelAccessAlarmStatus HWLIMIT
public static final ChannelAccessAlarmStatus CALC
public static final ChannelAccessAlarmStatus SCAN
public static final ChannelAccessAlarmStatus LINK
public static final ChannelAccessAlarmStatus SOFT
public static final ChannelAccessAlarmStatus BAD_SUB
public static final ChannelAccessAlarmStatus UDF
public static final ChannelAccessAlarmStatus DISABLE
public static final ChannelAccessAlarmStatus SIMM
public static final ChannelAccessAlarmStatus READ_ACCESS
public static final ChannelAccessAlarmStatus WRITE_ACCESS
public short toAlarmStatusCode()
forAlarmStatusCode(short)
public String toString()
public static ChannelAccessAlarmStatus forAlarmStatusCode(short statusCode)
statusCode
. This can
be used to translate a status code received from the network into a
severity.statusCode
- integer number identifying the alarm status.null
).public int hashCode()
Returns a hash code value for this alarm-status object. This method is supported for the benefit of hash tables. The hash code is calculated based on the numeric status code of this alarm-status object.
If two alarm-status objects are equal (as indicated by the return value
of equals(Object)
), they also have the same hash code. However,
the fact that two alarm-status objects have the same hash code does not
imply that they are equal.
public boolean equals(Object obj)
Copyright © 2014–2016 aquenos GmbH. All rights reserved.