com.inductiveautomation.opcua.types

Class StatusCode

java.lang.Object

com.inductiveautomation.opcua.types.StatusCode

All Implemented Interfaces:

java.io.Serializable

public class StatusCode
extends java.lang.Object
implements java.io.Serializable

A StatusCode is a 32-bit numerical value that is used to report the outcome of an operation the status of the information returned by that operation. See OPC-UA Spec Part 4 Section 7.33

Thep top 16 bits represent the numeric value of the code that shall be used for detecting specific errors or conditions. The bottom 16 bits are bit flags that contain additional information but do not affect the meaning of the StatusCode

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StatusCode.InfoType
static class	StatusCode.Severity
static class	StatusCode.SubCode

Field Summary

Fields

Modifier and Type	Field and Description
static StatusCode	BAD
static StatusCode	BAD_CONFIG_ERROR
static StatusCode	BAD_CONNECTION_CLOSED
static StatusCode	BAD_CONNECTION_REJECTED
static StatusCode	BAD_DEMO_EXPIRED
static StatusCode	BAD_INTERNAL_ERROR
static StatusCode	BAD_NODEID_UNKNOWN
static StatusCode	BAD_NOMATCH
static StatusCode	BAD_NOT_CONNECTED
static StatusCode	BAD_NOT_FOUND
static StatusCode	BAD_NOT_READABLE
static StatusCode	BAD_NOT_WRITABLE
static StatusCode	BAD_OUT_OF_RANGE
static StatusCode	BAD_SECURITY_CHECK_FAILED
static StatusCode	BAD_SERVER_NOT_CONNECTED
static StatusCode	BAD_SESSION_ID_INVALID
static StatusCode	BAD_SESSION_NOT_ACTIVATED
static StatusCode	BAD_STALE
static StatusCode	BAD_TIMEOUT
static StatusCode	BAD_TRIAL_TIMEOUT Used to be OutOfService, but that's used too much.
static StatusCode	BAD_UNKNOWN
static StatusCode	BAD_USER_ACCESS_DENIED
static StatusCode	BAD_VALUE
static StatusCode	BAD_VALUE_UNAVAILABLE
static StatusCode	BAD_WAITING_FOR_INITIAL_DATA
static StatusCode	GOOD
static StatusCode	GOOD_VALUE
static int	SEMANTICS_CHANGED_MASK
static int	STRUCTURE_CHANGED_MASK
protected int	value

Constructor Summary

Constructors

Constructor and Description
StatusCode(int value)
StatusCode(StatusCode.SubCode subcode) Creates a new status code with the given SubCode and false for the datavalue flag.
StatusCode(StatusCode.SubCode subcode, boolean datavalue) Creates a new status code based on the given SubCode
StatusCode(StatusCode.SubCode subCode, StatusCode.Severity severity)
StatusCode(StatusCode.SubCode subCode, StatusCode.Severity severity, boolean dataValue)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
short	getInfoBits() Returns the InfoBits of the StatusCode (bits 0:9).
StatusCode.InfoType	getInfoType()
java.lang.String	getName()
short	getRawSubCode()
int	getRawValue()
StatusCode.Severity	getSeverity()
StatusCode.SubCode	getSubCode()
int	hashCode()
boolean	isGood()
boolean	isSemanticsChanged()
boolean	isStructureChanged()
static void	main(java.lang.String[] args)
java.lang.String	toString()
static StatusCode	worstOf(StatusCode q1, StatusCode q2) Returns the 'worst' or 'most severe' of the two qualities.
static StatusCode	worstOfAll(StatusCode... q)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

GOOD

public static final StatusCode GOOD

GOOD_VALUE

public static final StatusCode GOOD_VALUE

BAD

public static final StatusCode BAD

BAD_VALUE

public static final StatusCode BAD_VALUE

BAD_VALUE_UNAVAILABLE

public static final StatusCode BAD_VALUE_UNAVAILABLE

BAD_STALE

public static final StatusCode BAD_STALE

BAD_CONFIG_ERROR

public static final StatusCode BAD_CONFIG_ERROR

BAD_NOT_FOUND

public static final StatusCode BAD_NOT_FOUND

BAD_INTERNAL_ERROR

public static final StatusCode BAD_INTERNAL_ERROR

BAD_SECURITY_CHECK_FAILED

public static final StatusCode BAD_SECURITY_CHECK_FAILED

BAD_NOT_READABLE

public static final StatusCode BAD_NOT_READABLE

BAD_NOT_WRITABLE

public static final StatusCode BAD_NOT_WRITABLE

BAD_TIMEOUT

public static final StatusCode BAD_TIMEOUT

BAD_UNKNOWN

public static final StatusCode BAD_UNKNOWN

BAD_WAITING_FOR_INITIAL_DATA

public static final StatusCode BAD_WAITING_FOR_INITIAL_DATA

BAD_SERVER_NOT_CONNECTED

public static final StatusCode BAD_SERVER_NOT_CONNECTED

BAD_CONNECTION_CLOSED

public static final StatusCode BAD_CONNECTION_CLOSED

BAD_CONNECTION_REJECTED

public static final StatusCode BAD_CONNECTION_REJECTED

BAD_NOT_CONNECTED

public static final StatusCode BAD_NOT_CONNECTED

BAD_NODEID_UNKNOWN

public static final StatusCode BAD_NODEID_UNKNOWN

BAD_NOMATCH

public static final StatusCode BAD_NOMATCH

BAD_SESSION_NOT_ACTIVATED

public static final StatusCode BAD_SESSION_NOT_ACTIVATED

BAD_SESSION_ID_INVALID

public static final StatusCode BAD_SESSION_ID_INVALID

BAD_USER_ACCESS_DENIED

public static final StatusCode BAD_USER_ACCESS_DENIED

BAD_TRIAL_TIMEOUT

public static final StatusCode BAD_TRIAL_TIMEOUT

Used to be OutOfService, but that's used too much. Has been changed to a more obscure sub code.

BAD_OUT_OF_RANGE

public static final StatusCode BAD_OUT_OF_RANGE

BAD_DEMO_EXPIRED

public static final StatusCode BAD_DEMO_EXPIRED

STRUCTURE_CHANGED_MASK

public static final int STRUCTURE_CHANGED_MASK

See Also:

Constant Field Values

SEMANTICS_CHANGED_MASK

public static final int SEMANTICS_CHANGED_MASK

See Also:

Constant Field Values

value

protected int value

Constructor Detail

StatusCode

public StatusCode(int value)

StatusCode

public StatusCode(StatusCode.SubCode subCode,
                  StatusCode.Severity severity)

StatusCode

public StatusCode(StatusCode.SubCode subCode,
                  StatusCode.Severity severity,
                  boolean dataValue)

StatusCode

public StatusCode(StatusCode.SubCode subcode)

Creates a new status code with the given SubCode and false for the datavalue flag.

Parameters:

subcode -

StatusCode

public StatusCode(StatusCode.SubCode subcode,
                  boolean datavalue)

Creates a new status code based on the given SubCode

Method Detail

main

public static void main(java.lang.String[] args)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getSeverity

public StatusCode.Severity getSeverity()

isGood

public boolean isGood()

getRawSubCode

public short getRawSubCode()

getSubCode

public StatusCode.SubCode getSubCode()

isStructureChanged

public boolean isStructureChanged()

isSemanticsChanged

public boolean isSemanticsChanged()

getInfoType

public StatusCode.InfoType getInfoType()

getInfoBits

public short getInfoBits()

Returns the InfoBits of the StatusCode (bits 0:9). The structure of these bits depends on the InfoType

getRawValue

public int getRawValue()

worstOf

public static StatusCode worstOf(StatusCode q1,
                                 StatusCode q2)

Returns the 'worst' or 'most severe' of the two qualities.

Parameters:

q1 -

q2 -

Returns:

worstOfAll

public static StatusCode worstOfAll(StatusCode... q)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getName

public java.lang.String getName()