StatusCode (prosys-opc-ua-sdk-client-server-pubsub 5.8.2-10 API)

java.lang.Object
- com.prosysopc.ua.stack.builtintypes.StatusCode

All Implemented Interfaces:

BitField
```
public final class StatusCode
extends Object
implements BitField
```
Represents an OPC UA StatusCode, an unsigned 32-bit value that identifies the result of an operation or the status of an associated value.
A StatusCode contains a severity indicating whether the status is good, uncertain, or bad, a subcode identifying the specific status or condition, and optional information bits that provide additional context.
StatusCode is immutable. Normally instances are created using the valueOf(UnsignedInteger) static factory method by passing in one of the constants from StatusCodes.

Field Summary

Fields
Modifier and Type	Field and Description
`static StatusCode`	`BAD` The StatusCode representing a bad status without a specific subcode.
`static StatusCode[]`	`EMPTY_ARRAY` An empty StatusCode array.
`static StatusCode`	`GOOD` The StatusCode representing a good status without a specific subcode.
`static int`	`HISTORIANBITS_CALCULATED` Indicates that the historical data value was calculated.
`static int`	`HISTORIANBITS_EXTRADATA` Indicates that additional historical data values exist.
`static int`	`HISTORIANBITS_INTERPOLATED` Indicates that the historical data value was interpolated.
`static int`	`HISTORIANBITS_MASK` These bits are set only when reading historical data.
`static int`	`HISTORIANBITS_MULTIVALUE` Indicates that multiple historical data values match the requested timestamp.
`static int`	`HISTORIANBITS_PARTIAL` Indicates that the historical data value represents a partial interval.
`static int`	`HISTORIANBITS_RAW` Indicates that the historical data value is raw data.
`static int`	`HISTORIANBITS_RESERVED` Reserved for future use.
`static NodeId`	`ID` Deprecated. use `Identifiers.StatusCode` instead.
`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` Indicates a bad StatusCode severity.
`static int`	`SEVERITY_GOOD` Indicates a good StatusCode severity.
`static int`	`SEVERITY_MASK` Indicates whether the StatusCode represents a good, bad or uncertain condition.
`static int`	`SEVERITY_UNCERTAIN` Indicates an uncertain StatusCode severity.
`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

Constructors
Constructor and Description

StatusCode(UnsignedInteger value)
Deprecated.
use valueOf(UnsignedInteger) instead.

Constructors
Constructor and Description
`StatusCode(UnsignedInteger value)` Deprecated. use `valueOf(UnsignedInteger)` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`boolean`	`equalsStatusCode(StatusCode statusCode)` Returns `true` if the given StatusCode has the same severity and subcode as this StatusCode.
`String`	`getDescription()` Returns the textual description of this StatusCode.
`static StatusCode`	`getFromBits(int value)` Returns a `StatusCode` that matches the given raw 32-bit representation.
`int`	`getHistorianBits()` Returns the historian bits that indicate the source and characteristics of historical data.
`int`	`getInfotype()` Returns the information type bits that indicate the type of additional information contained in this StatusCode.
`int`	`getLimitBits()` Returns the limit bits that indicate whether the associated value has reached a limit.
`String`	`getName()` Returns the symbolic name of this StatusCode, such as `Bad_NodeIdUnknown`.
`int`	`getSeverity()` Returns the severity of this StatusCode, indicating whether the status is good, uncertain, or bad.
`int`	`getSubcode()` Returns the subcode that identifies the specific status or condition represented by this StatusCode.
`UnsignedInteger`	`getValue()` Returns the complete 32-bit value of this StatusCode as an `UnsignedInteger`.
`int`	`getValueAsIntBits()` Returns the complete raw 32-bit representation of this StatusCode as an `int`.
`int`	`hashCode()`
`boolean`	`isBad()` Returns `true` if this status code is bad.
`boolean`	`isBitSet(int position)` Is bit set in position.
`boolean`	`isGood()` Returns `true` if this status code is good.
`boolean`	`isNotBad()` Returns `true` if this status code is not bad.
`boolean`	`isNotGood()` Returns `true` if this status code is not good.
`boolean`	`isNotUncertain()` Returns `true` if this status code is not uncertain.
`boolean`	`isOverflow()` Returns `true` if the overflow bit is set, indicating that not every detected change was returned because the MonitoredItem queue reached its limit and data had to be discarded.
`boolean`	`isSemanticsChanged()` Returns `true` if the semantics changed bit is set, indicating that the semantics of the associated data value have changed.
`boolean`	`isStatusCode(UnsignedInteger statusCode)` Returns `true` if the given status code has the same severity and subcode as this StatusCode.
`boolean`	`isStructureChanged()` Returns `true` if the structure changed bit is set, indicating that the structure of the associated data value has changed.
`boolean`	`isUncertain()` Returns `true` if this status code is uncertain.
`static StatusCode`	`parseStatusCode(String string)` Parses a StatusCode from the given string.
`String`	`toString()`
`static StatusCode`	`valueOf(UnsignedInteger value)` Returns a `StatusCode` that matches the given 32-bit unsigned value.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ID
```
@Deprecated
public static final NodeId ID
```
    Deprecated. use Identifiers.StatusCode instead.
    
    The NodeId for the DataType node StatusCode in the UA AddressSpace.
  - EMPTY_ARRAY
```
public static final StatusCode[] EMPTY_ARRAY
```
    An empty StatusCode array.
  - SEVERITY_MASK
```
public static final int SEVERITY_MASK
```
    Indicates whether the StatusCode represents a good, bad or uncertain condition.
    
    See Also:
    
    Constant Field Values
  - SEVERITY_GOOD
```
public static final int SEVERITY_GOOD
```
    Indicates a good StatusCode severity.
  - SEVERITY_UNCERTAIN
```
public static final int SEVERITY_UNCERTAIN
```
    Indicates an uncertain StatusCode severity.
  - SEVERITY_BAD
```
public static final int SEVERITY_BAD
```
    Indicates a bad StatusCode severity.
  - GOOD
```
public static final StatusCode GOOD
```
    The StatusCode representing a good status without a specific subcode.
  - BAD
```
public static final StatusCode BAD
```
    The StatusCode representing a bad status without a specific subcode. Normally one of the specific bad status code constants from StatusCodes should be used instead.
  - RES1_MASK
```
public static final int RES1_MASK
```
    Reserved for future use. Shall always be zero.
    
    See Also:
    
    Constant Field Values
  - SUBCODE_MASK
```
public static final int SUBCODE_MASK
```
    The code is a numeric value assigned to represent different conditions. Each code has a symbolic name and a numeric value. All descriptions in the OPC UA specification refer to the symbolic name. Part 6 maps the symbolic names onto a numeric value.
    
    See Also:
    
    Constant Field Values
  - STRUCTURECHANGED_MASK
```
public static final int STRUCTURECHANGED_MASK
```
    Indicates that the structure of the associated data value has changed since the last Notification. Clients should not process the data value unless they re-read the metadata. Servers shall set this bit if the DataTypeEncoding used for a Variable changes. Clause 7.23 describes how the DataTypeEncoding is specified for a Variable.
    The bit is also set if the data type Attribute of the Variable changes. A Variable with data type BaseDataType does not require the bit to be set when the data type changes.
    Servers shall also set this bit if the ArrayDimensions or the ValueRank Attribute or the EnumStrings Property of the DataType of the Variable changes.
    This bit is provided to warn Clients that parse complex data values that their parsing routines could fail because the serialized form of the data value has changed.
    This bit has meaning only for StatusCodes returned as part of a data change Notification or the HistoryRead. StatusCodes used in other contexts shall always set this bit to zero.
    
    See Also:
    
    Constant Field Values
  - SEMANTICSCHANGED_MASK
```
public static final int SEMANTICSCHANGED_MASK
```
    Indicates that the semantics of the associated data value have changed. Clients should not process the data value until they re-read the metadata associated with the Variable.
    Servers should set this bit if the metadata has changed in way that could cause application errors if the Client does not re-read the metadata. For example, a change to the engineering units could create problems if the Client uses the value to perform calculations.
    Part 8 defines the conditions where a Server shall set this bit for a DA Variable. Other specifications may define additional conditions. A Server may define other conditions that cause this bit to be set.
    This bit has meaning only for StatusCodes returned as part of a data change Notification or the HistoryRead. StatusCodes used in other contexts shall always set this bit to zero.
    
    See Also:
    
    Constant Field Values
  - RES2_MASK
```
public static final int RES2_MASK
```
    Reserved for future use. Shall always be zero.
    
    See Also:
    
    Constant Field Values
  - INFOTYPE_MASK
```
public static final int INFOTYPE_MASK
```
    The type of information contained in the info bits.
    
    See Also:
    
    Constant Field Values
  - INFOTYPE_DATAVALUE
```
public static final int INFOTYPE_DATAVALUE
```
    The type of information is related to DataValue.
    
    See Also:
    
    Constant Field Values
  - INFOBITS_MASK
```
public static final int INFOBITS_MASK
```
    Additional information bits that qualify the StatusCode. The structure of these bits depends on the Info Type field.
    
    See Also:
    
    Constant Field Values
  - LIMITBITS_MASK
```
public static final int LIMITBITS_MASK
```
    The limit bits associated with the data value.
    
    See Also:
    
    Constant Field Values
  - LIMITBITS_NONE
```
public static final int LIMITBITS_NONE
```
    The value is free to change.
    
    See Also:
    
    Constant Field Values
  - LIMITBITS_LOW
```
public static final int LIMITBITS_LOW
```
    The value is at the lower limit for the data source.
    
    See Also:
    
    Constant Field Values
  - LIMITBITS_HIGH
```
public static final int LIMITBITS_HIGH
```
    The value is at the higher limit for the data source.
    
    See Also:
    
    Constant Field Values
  - LIMITBITS_CONSTANT
```
public static final int LIMITBITS_CONSTANT
```
    The value is constant and cannot change.
    
    See Also:
    
    Constant Field Values
  - OVERFLOW_MASK
```
public static final 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.
    Consists of the INFOTYPE_DATAVALUE and OVERFLOW_BIT
    
    See Also:
    
    Constant Field Values
  - OVERFLOW_BIT
```
public static final 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.
    Must be used with the INFOTYPE_DATAVALUE.
    
    See Also:
    
    OVERFLOW_MASK, Constant Field Values
  - HISTORIANBITS_MASK
```
public static final int HISTORIANBITS_MASK
```
    These bits are set only when reading historical data. They indicate where the data value came from and provide information that affects how the Client uses the data value.
    
    See Also:
    
    Constant Field Values
  - HISTORIANBITS_RAW
```
public static final int HISTORIANBITS_RAW
```
    Indicates that the historical data value is raw data.
    
    See Also:
    
    Constant Field Values
  - HISTORIANBITS_CALCULATED
```
public static final int HISTORIANBITS_CALCULATED
```
    Indicates that the historical data value was calculated.
    
    See Also:
    
    Constant Field Values
  - HISTORIANBITS_INTERPOLATED
```
public static final int HISTORIANBITS_INTERPOLATED
```
    Indicates that the historical data value was interpolated.
    
    See Also:
    
    Constant Field Values
  - HISTORIANBITS_RESERVED
```
public static final int HISTORIANBITS_RESERVED
```
    Reserved for future use.
    
    See Also:
    
    Constant Field Values
  - HISTORIANBITS_PARTIAL
```
public static final int HISTORIANBITS_PARTIAL
```
    Indicates that the historical data value represents a partial interval.
    
    See Also:
    
    Constant Field Values
  - HISTORIANBITS_EXTRADATA
```
public static final int HISTORIANBITS_EXTRADATA
```
    Indicates that additional historical data values exist.
    
    See Also:
    
    Constant Field Values
  - HISTORIANBITS_MULTIVALUE
```
public static final int HISTORIANBITS_MULTIVALUE
```
    Indicates that multiple historical data values match the requested timestamp.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StatusCode
```
@Deprecated
public StatusCode(UnsignedInteger value)
```
    Deprecated. use valueOf(UnsignedInteger) instead.
    
    Create a StatusCode that matches the given 32-bit unsigned value.
- Method Detail
  - getFromBits
```
public static StatusCode getFromBits(int value)
```
    Returns a StatusCode that matches the given raw 32-bit representation. The input int is treated as unsigned and the result is equivalent to valueOf(UnsignedInteger) when used with UnsignedInteger.getFromBits(int). This method may return a cached instance.
  - parseStatusCode
```
public static StatusCode parseStatusCode(String string)
```
    Parses a StatusCode from the given string. The string may contain an unsigned decimal value, a hexadecimal value, or a symbolic status code name such as Bad_NodeIdUnknown. Throws IllegalArgumentException if the string cannot be parsed. This method may return a cached instance.
  - valueOf
```
public static StatusCode valueOf(UnsignedInteger value)
```
    Returns a StatusCode that matches the given 32-bit unsigned value. This method may return a cached instance.
    
    See Also:
    
    getFromBits(int)
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsStatusCode
```
public boolean equalsStatusCode(StatusCode statusCode)
```
    Returns true if the given StatusCode has the same severity and subcode as this StatusCode. Information bits are ignored when comparing the status codes.
    
    See Also:
    
    isStatusCode(UnsignedInteger)
  - getDescription
```
public String getDescription()
```
    Returns the textual description of this StatusCode. Returns an empty string if no description is known for this StatusCode.
  - getHistorianBits
```
public int getHistorianBits()
```
    Returns the historian bits that indicate the source and characteristics of historical data.
    
    See Also:
    
    HISTORIANBITS_MASK
  - getInfotype
```
public int getInfotype()
```
    Returns the information type bits that indicate the type of additional information contained in this StatusCode.
    
    See Also:
    
    INFOTYPE_MASK
  - getLimitBits
```
public int getLimitBits()
```
    Returns the limit bits that indicate whether the associated value has reached a limit.
    
    See Also:
    
    LIMITBITS_MASK
  - getName
```
public String getName()
```
    Returns the symbolic name of this StatusCode, such as Bad_NodeIdUnknown. Returns an empty string if no name is known for this StatusCode.
  - getSeverity
```
public int getSeverity()
```
    Returns the severity of this StatusCode, indicating whether the status is good, uncertain, or bad. The result is one of SEVERITY_GOOD, SEVERITY_UNCERTAIN, or SEVERITY_BAD. When checking for a specific severity, prefer using one of the convenience methods listed below.
    
    See Also:
    
    isGood(), isNotGood(), isUncertain(), isNotUncertain(), isBad(), isNotBad()
  - getSubcode
```
public int getSubcode()
```
    Returns the subcode that identifies the specific status or condition represented by this StatusCode.
    
    See Also:
    
    SUBCODE_MASK
  - getValue
```
public UnsignedInteger getValue()
```
    Returns the complete 32-bit value of this StatusCode as an UnsignedInteger.
    
    See Also:
    
    getValueAsIntBits()
  - getValueAsIntBits
```
public int getValueAsIntBits()
```
    Returns the complete raw 32-bit representation of this StatusCode as an int. The returned value should be interpreted as unsigned.
    
    See Also:
    
    getValue()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isBad
```
public boolean isBad()
```
    Returns true if this status code is bad.
  - isBitSet
```
public boolean isBitSet(int position)
```
    Description copied from interface: BitField
    
    Is bit set in position. Positions start from 0. Note that this method will return false for positions outside of range.
    
    Specified by:
    
    isBitSet in interface BitField
  - isGood
```
public boolean isGood()
```
    Returns true if this status code is good.
  - isNotBad
```
public boolean isNotBad()
```
    Returns true if this status code is not bad.
  - isNotGood
```
public boolean isNotGood()
```
    Returns true if this status code is not good.
  - isNotUncertain
```
public boolean isNotUncertain()
```
    Returns true if this status code is not uncertain.
  - isOverflow
```
public boolean isOverflow()
```
    Returns true if the overflow bit is set, indicating that not every detected change was returned because the MonitoredItem queue reached its limit and data had to be discarded.
    
    See Also:
    
    OVERFLOW_MASK, OVERFLOW_BIT
  - isSemanticsChanged
```
public boolean isSemanticsChanged()
```
    Returns true if the semantics changed bit is set, indicating that the semantics of the associated data value have changed.
    
    See Also:
    
    SEMANTICSCHANGED_MASK
  - isStatusCode
```
public boolean isStatusCode(UnsignedInteger statusCode)
```
    Returns true if the given status code has the same severity and subcode as this StatusCode. Information bits are ignored when comparing the status codes.
    
    See Also:
    
    equalsStatusCode(StatusCode)
  - isStructureChanged
```
public boolean isStructureChanged()
```
    Returns true if the structure changed bit is set, indicating that the structure of the associated data value has changed.
    
    See Also:
    
    STRUCTURECHANGED_MASK
  - isUncertain
```
public boolean isUncertain()
```
    Returns true if this status code is uncertain.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class StatusCode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ID

EMPTY_ARRAY

SEVERITY_MASK

SEVERITY_GOOD

SEVERITY_UNCERTAIN

SEVERITY_BAD

GOOD

BAD

RES1_MASK

SUBCODE_MASK

STRUCTURECHANGED_MASK

SEMANTICSCHANGED_MASK

RES2_MASK

INFOTYPE_MASK

INFOTYPE_DATAVALUE

INFOBITS_MASK

LIMITBITS_MASK

LIMITBITS_NONE

LIMITBITS_LOW

LIMITBITS_HIGH

LIMITBITS_CONSTANT

OVERFLOW_MASK

OVERFLOW_BIT

HISTORIANBITS_MASK

HISTORIANBITS_RAW

HISTORIANBITS_CALCULATED

HISTORIANBITS_INTERPOLATED

HISTORIANBITS_RESERVED

HISTORIANBITS_PARTIAL

HISTORIANBITS_EXTRADATA

HISTORIANBITS_MULTIVALUE

Constructor Detail

StatusCode

Method Detail

getFromBits

parseStatusCode

valueOf

equals

equalsStatusCode

getDescription

getHistorianBits

getInfotype

getLimitBits

getName

getSeverity

getSubcode

getValue

getValueAsIntBits

hashCode

isBad

isBitSet

isGood

isNotBad

isNotGood

isNotUncertain

isOverflow

isSemanticsChanged

isStatusCode

isStructureChanged

isUncertain

toString