OptionSet.Fields (prosys-opc-ua-sdk-client-server-pubsub 5.6.2-227 API)

java.lang.Object
- java.lang.Enum<OptionSet.Fields>
- - com.prosysopc.ua.stack.core.OptionSet.Fields

All Implemented Interfaces:

FieldSpecification, UaNamespaceTranslateable<FieldSpecification>, Serializable, Comparable<OptionSet.Fields>

Enclosing class:

OptionSet
```
public static enum OptionSet.Fields
extends Enum<OptionSet.Fields>
implements FieldSpecification
```
The fields of the OptionSet Structure.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.prosysopc.ua.typedictionary.FieldSpecification
  FieldSpecification.Builder
- Nested classes/interfaces inherited from interface com.prosysopc.ua.UaNamespaceTranslateable
  UaNamespaceTranslateable.Context

Enum Constant Summary

Enum Constants
Enum Constant and Description

ValidBits

Value

Enum Constants
Enum Constant and Description
`ValidBits`
`Value`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UaArrayDimensions`	`getArrayDimensions()` Returns ArrayDimensions of the field (or null if not known).
`UaNodeId`	`getDataTypeId()` Returns the DataType node's NodeId of the UA type of this field.
`String`	`getDescription()` Returns Description of the field.
`int`	`getFieldIndex()` Returns a "field index" position of this field.
`Class<?>`	`getJavaClass()` Returns the java Class of the field.
`int`	`getJavaClassDimensions()` Returns the dimensions this field has.
`int`	`getMaxStringLength()` Maximum length of a String this field can have (or 0 if not known or the field is not a String type).
`String`	`getName()` Returns the name of the field.
`int`	`getValueRank()` Returns the ValueRank defining the number of dimensions of the field.
`boolean`	`isAllowSubTypes()` Returns true if the field allows sub types to be set.
`boolean`	`isArray()` Returns true if this field is an (potentially multidimensional) array.
`boolean`	`isOptional()` Returns true if the field is optional.
`static OptionSet.Fields`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static OptionSet.Fields[]`	`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

Methods inherited from interface com.prosysopc.ua.typedictionary.FieldSpecification
builder, getCompositeClass, getEncodeTypeId, getXmlName, toBuilder, withTranslatedNamespaces

- Enum Constant Detail
  - Value
```
public static final OptionSet.Fields Value
```
  - ValidBits
```
public static final OptionSet.Fields ValidBits
```
- Method Detail
  - values
```
public static OptionSet.Fields[] 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 (OptionSet.Fields c : OptionSet.Fields.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static OptionSet.Fields 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
  - getArrayDimensions
```
public UaArrayDimensions getArrayDimensions()
```
    Description copied from interface: FieldSpecification
    
    Returns ArrayDimensions of the field (or null if not known).
    
    Specified by:
    
    getArrayDimensions in interface FieldSpecification
  - getDataTypeId
```
public UaNodeId getDataTypeId()
```
    Description copied from interface: FieldSpecification
    
    Returns the DataType node's NodeId of the UA type of this field. For types read from a TypeDictionary this is a best-effort guess and might be null.
    
    Specified by:
    
    getDataTypeId in interface FieldSpecification
    
    Returns:
    
    DataTypeId of the field, can be null if unknown.
  - getDescription
```
public String getDescription()
```
    Description copied from interface: FieldSpecification
    
    Returns Description of the field. Can be null if not known.
    
    Specified by:
    
    getDescription in interface FieldSpecification
  - getFieldIndex
```
public int getFieldIndex()
```
    Description copied from interface: FieldSpecification
    
    Returns a "field index" position of this field. Mostly intended for SDK internal use. The fields of a Structure can be thought as an Object[], this gives a suitable index (first field is 0, second is 1 and so on).
    
    Specified by:
    
    getFieldIndex in interface FieldSpecification
  - getJavaClass
```
public Class<?> getJavaClass()
```
    Description copied from interface: FieldSpecification
    
    Returns the java Class of the field. If the field is array type, then this Class object also is an array version, e.g. for a scalar Double field this returns Double.class, for 1-dim Double field Double[].class and for 2-dim Double[][].class and so on.
    
    Specified by:
    
    getJavaClass in interface FieldSpecification
  - getJavaClassDimensions
```
public int getJavaClassDimensions()
```
    Description copied from interface: FieldSpecification
    
    Returns the dimensions this field has. The return is the same as MultiDimensionArrayUtils.getClassDimensions(getJavaClass()). For non-scalar fields this return is equal to the FieldSpecification.getValueRank(), for scalar this returns 0.
    
    Specified by:
    
    getJavaClassDimensions in interface FieldSpecification
  - getMaxStringLength
```
public int getMaxStringLength()
```
    Description copied from interface: FieldSpecification
    
    Maximum length of a String this field can have (or 0 if not known or the field is not a String type). If an array applies to each element.
    
    Specified by:
    
    getMaxStringLength in interface FieldSpecification
  - getName
```
public String getName()
```
    Description copied from interface: FieldSpecification
    
    Returns the name of the field.
    
    Specified by:
    
    getName in interface FieldSpecification
  - getValueRank
```
public int getValueRank()
```
    Description copied from interface: FieldSpecification
    
    Returns the ValueRank defining the number of dimensions of the field. Either -1 (scalar) or a fixed number of dimensions (1+).
    
    Specified by:
    
    getValueRank in interface FieldSpecification
  - isAllowSubTypes
```
public boolean isAllowSubTypes()
```
    Description copied from interface: FieldSpecification
    
    Returns true if the field allows sub types to be set.
    
    Specified by:
    
    isAllowSubTypes in interface FieldSpecification
  - isArray
```
public boolean isArray()
```
    Description copied from interface: FieldSpecification
    
    Returns true if this field is an (potentially multidimensional) array. Returns false if it is a scalar.
    
    Specified by:
    
    isArray in interface FieldSpecification
  - isOptional
```
public boolean isOptional()
```
    Description copied from interface: FieldSpecification
    
    Returns true if the field is optional.
    
    Specified by:
    
    isOptional in interface FieldSpecification

Enum OptionSet.Fields

Nested Class Summary

Nested classes/interfaces inherited from interface com.prosysopc.ua.typedictionary.FieldSpecification

Nested classes/interfaces inherited from interface com.prosysopc.ua.UaNamespaceTranslateable

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface com.prosysopc.ua.typedictionary.FieldSpecification

Enum Constant Detail

Value

ValidBits

Method Detail

values

valueOf

getArrayDimensions

getDataTypeId

getDescription

getFieldIndex

getJavaClass

getJavaClassDimensions

getMaxStringLength

getName

getValueRank

isAllowSubTypes

isArray

isOptional