|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.opcfoundation.ua.builtintypes.StatusCode
public final class StatusCode
A numeric identifier for a error or condition that is associated with a value or an operation. StatusCode is immutable. TODO Add type-safe enums
StatusCodes,
StatusCodeDescriptions| Field Summary | |
|---|---|
static StatusCode |
BAD
Constant BAD |
static StatusCode |
GOOD
GOOD Result |
static int |
HISTORIANBITS_CALCULATED
Constant HISTORIANBITS_CALCULATED=0x00000001 |
static int |
HISTORIANBITS_EXTRADATA
Constant HISTORIANBITS_EXTRADATA=0x00000008 |
static int |
HISTORIANBITS_INTERPOLATED
Constant HISTORIANBITS_INTERPOLATED=0x00000002 |
static int |
HISTORIANBITS_MASK
These bits are set only when reading historical data. |
static int |
HISTORIANBITS_MULTIVALUE
Constant HISTORIANBITS_MULTIVALUE=0x00000010 |
static int |
HISTORIANBITS_PARTIAL
Constant HISTORIANBITS_PARTIAL=0x00000004 |
static int |
HISTORIANBITS_RAW
Constant HISTORIANBITS_RAW=0x00000000 |
static int |
HISTORIANBITS_RESERVED
Constant HISTORIANBITS_RESERVED=0x00000003 |
static NodeId |
ID
Constant ID |
static int |
INFOBITS_MASK
Additional information bits that qualify the StatusCode. |
static int |
INFOTYPE_DATAVALUE
The type of information is related to DataValue. |
static int |
INFOTYPE_MASK
The type of information contained in the info bits. |
static int |
LIMITBITS_CONSTANT
The value is constant and cannot change. |
static int |
LIMITBITS_HIGH
The value is at the higher limit for the data source. |
static int |
LIMITBITS_LOW
The value is at the lower limit for the data source. |
static int |
LIMITBITS_MASK
The limit bits associated with the data value. |
static int |
LIMITBITS_NONE
The value is free to change. |
static int |
OVERFLOW_BIT
If this bit is set, not every detected change has been returned since the Server's queue buffer for the MonitoredItem reached its limit and had to purge out data. |
static int |
OVERFLOW_MASK
If these bits are set, not every detected change has been returned since the Server's queue buffer for the MonitoredItem reached its limit and had to purge out data. |
static int |
RES1_MASK
Reserved for future use. |
static int |
RES2_MASK
Reserved for future use. |
static int |
SEMANTICSCHANGED_MASK
Indicates that the semantics of the associated data value have changed. |
static int |
SEVERITY_BAD
Constant SEVERITY_BAD=0x80000000 |
static int |
SEVERITY_GOOD
Constant SEVERITY_GOOD=0x00000000 |
static int |
SEVERITY_MASK
Indicates whether the StatusCode represents a good, bad or uncertain condition. |
static int |
SEVERITY_UNCERTAIN
Constant SEVERITY_UNCERTAIN=0x40000000 |
static int |
STRUCTURECHANGED_MASK
Indicates that the structure of the associated data value has changed since the last Notification. |
static int |
SUBCODE_MASK
The code is a numeric value assigned to represent different conditions. |
| Constructor Summary | |
|---|---|
StatusCode(UnsignedInteger value)
Constructor for StatusCode. |
|
| Method Summary | |
|---|---|
boolean |
equals(Object obj)
|
boolean |
equalsStatusCode(StatusCode statusCode)
Check if the status codes equal to severity and subcode, ignoring the lowest bits of the code. |
String |
getDescription()
getDescription. |
static StatusCode |
getFromBits(int value)
getFromBits. |
int |
getHistorianBits()
getHistorianBits. |
int |
getInfotype()
getInfotype. |
int |
getLimitBits()
getLimitBits. |
String |
getName()
getName. |
int |
getSeverity()
getSeverity. |
int |
getSubcode()
getSubcode. |
UnsignedInteger |
getValue()
Getter for the field value. |
int |
getValueAsIntBits()
getValueAsIntBits. |
int |
hashCode()
|
boolean |
isBad()
Tests if this status code is bad. |
boolean |
isGood()
Tests if this status code is good. |
boolean |
isNotBad()
tests if a status code is not bad. |
boolean |
isNotGood()
Tests if this status code is not good. |
boolean |
isNotUncertain()
Tests if this status code is not uncertain. |
boolean |
isOverflow()
isOverflow. |
boolean |
isSemanticsChanged()
isSemanticsChanged. |
boolean |
isStatusCode(UnsignedInteger statusCode)
Matches argument against subcode and severity. |
boolean |
isStructureChanged()
isStructureChanged. |
boolean |
isUncertain()
Tests if this status code is not uncertain. |
String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final NodeId ID
ID
public static final int SEVERITY_MASK
public static final int SEVERITY_GOOD
SEVERITY_GOOD=0x00000000
public static final int SEVERITY_UNCERTAIN
SEVERITY_UNCERTAIN=0x40000000
public static final int SEVERITY_BAD
SEVERITY_BAD=0x80000000
public static final StatusCode GOOD
public static final StatusCode BAD
BAD
public static final int RES1_MASK
public static final int SUBCODE_MASK
public static final int STRUCTURECHANGED_MASK
public static final int SEMANTICSCHANGED_MASK
public static final int RES2_MASK
public static final int INFOTYPE_MASK
public static final int INFOTYPE_DATAVALUE
public static final int INFOBITS_MASK
public static final int LIMITBITS_MASK
public static final int LIMITBITS_NONE
public static final int LIMITBITS_LOW
public static final int LIMITBITS_HIGH
public static final int LIMITBITS_CONSTANT
public static final int OVERFLOW_MASK
Consists of the INFOTYPE_DATAVALUE and OVERFLOW_BIT
public static final int OVERFLOW_BIT
Must be used with the INFOTYPE_DATAVALUE.
OVERFLOW_MASK,
Constant Field Valuespublic static final int HISTORIANBITS_MASK
public static final int HISTORIANBITS_RAW
HISTORIANBITS_RAW=0x00000000
public static final int HISTORIANBITS_CALCULATED
HISTORIANBITS_CALCULATED=0x00000001
public static final int HISTORIANBITS_INTERPOLATED
HISTORIANBITS_INTERPOLATED=0x00000002
public static final int HISTORIANBITS_RESERVED
HISTORIANBITS_RESERVED=0x00000003
public static final int HISTORIANBITS_PARTIAL
HISTORIANBITS_PARTIAL=0x00000004
public static final int HISTORIANBITS_EXTRADATA
HISTORIANBITS_EXTRADATA=0x00000008
public static final int HISTORIANBITS_MULTIVALUE
HISTORIANBITS_MULTIVALUE=0x00000010
| Constructor Detail |
|---|
public StatusCode(UnsignedInteger value)
Constructor for StatusCode.
value - a UnsignedInteger object.| Method Detail |
|---|
public static StatusCode getFromBits(int value)
getFromBits.
value - a int.
StatusCode object.public int getValueAsIntBits()
getValueAsIntBits.
public UnsignedInteger getValue()
Getter for the field value.
UnsignedInteger object.public int hashCode()
hashCode in class Objectpublic boolean equals(Object obj)
equals in class Objectpublic String getDescription()
getDescription.
String object.public String getName()
getName.
String object.public String toString()
toString in class Objectpublic boolean isBad()
public boolean isGood()
public boolean isNotBad()
public boolean isNotGood()
public boolean isNotUncertain()
public boolean isUncertain()
public boolean isSemanticsChanged()
isSemanticsChanged.
public boolean isStructureChanged()
isStructureChanged.
public boolean isOverflow()
isOverflow.
public int getSeverity()
getSeverity.
public int getSubcode()
getSubcode.
public int getInfotype()
getInfotype.
public int getLimitBits()
getLimitBits.
public int getHistorianBits()
getHistorianBits.
public boolean isStatusCode(UnsignedInteger statusCode)
StatusCodes.
statusCode - a UnsignedInteger object.
equalsStatusCode(StatusCode)public boolean equalsStatusCode(StatusCode statusCode)
statusCode - the StatusCode to compare this one to
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||