com.prosysopc.ua.typedictionary

Enum StructureSpecification.StructureType

java.lang.Object

java.lang.Enum<StructureSpecification.StructureType>

com.prosysopc.ua.typedictionary.StructureSpecification.StructureType

All Implemented Interfaces:

Serializable, Comparable<StructureSpecification.StructureType>

Enclosing interface:

StructureSpecification

public static enum StructureSpecification.StructureType
extends Enum<StructureSpecification.StructureType>

Type of a Structure. Optional Structures and Unions have a special mask encoded as their first field, which defines what optional fields or which union field is encoded.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NORMAL A normal Structure.
OPTIONAL A Structure where some fields have been marked as optional.
SUBTYPES A Structure added in OPC UA 1.04.10 errata that allows subtypes to be used in marked fields.
UNION A Structure that has zero or exactly one of it's fields present in the binary stream.
UNION_SUBTYPES A Structure added in OPC UA 1.04.10 errata that allows subtypes to be used in marked fields, but only one of these fields at most can be present in the binary stream.

Method Summary

Modifier and Type	Method and Description
boolean	isUnion() Returns true, if this is UNION or UNION_SUBTYPES.
static StructureSpecification.StructureType	valueOf(String name) Returns the enum constant of this type with the specified name.
static StructureSpecification.StructureType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORMAL

public static final StructureSpecification.StructureType NORMAL

A normal Structure. Before OPC UA 1.03, this was the only kind of Structure that existed.

OPTIONAL

public static final StructureSpecification.StructureType OPTIONAL

A Structure where some fields have been marked as optional. Added in OPC UA 1.03. In the SDK fields that can be optional are marked as "not present" in the binary stream if their value is set to null.

UNION

public static final StructureSpecification.StructureType UNION

A Structure that has zero or exactly one of it's fields present in the binary stream. Added in OPC UA 1.03. In the SDK these Structures can only have zero or exactly one of their fields set to a non-null value.

SUBTYPES

public static final StructureSpecification.StructureType SUBTYPES

A Structure added in OPC UA 1.04.10 errata that allows subtypes to be used in marked fields. These fields java type is currently ExtensionObject (for fields whose datatype is a Structure type) or Object (for all other types).

UNION_SUBTYPES

public static final StructureSpecification.StructureType UNION_SUBTYPES

A Structure added in OPC UA 1.04.10 errata that allows subtypes to be used in marked fields, but only one of these fields at most can be present in the binary stream. These fields java type is currently ExtensionObject (for fields whose datatype is a Structure type) or Object (for all other types). Only one of the fields can have non-null value.

Method Detail

values

public static StructureSpecification.StructureType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StructureSpecification.StructureType c : StructureSpecification.StructureType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StructureSpecification.StructureType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isUnion

public boolean isUnion()

Returns true, if this is UNION or UNION_SUBTYPES.