AbstractOptionSetDataType (prosys-opc-ua-sdk-client-server-pubsub 5.6.2-227 API)

java.lang.Object
- com.prosysopc.ua.AbstractOptionSetDataType<T,S,U,V>

Type Parameters:

T - Enum defining the Options of the OptionSet.

S - The BuiltIn Type which is used in binary transmissions for the type.

U - The type (that inherits this) itself.

V - The Builder for the type itself (that inherits this).

All Implemented Interfaces:

BitField, OptionSetDataType<T,S>, UaOptionSet

Direct Known Subclasses:

AccessLevelExType, AccessLevelType, AccessRestrictionType, AlarmMask, AttributeWriteMask, DataSetFieldContentMask, DataSetFieldFlags, EventNotifierType, JsonDataSetMessageContentMask, JsonNetworkMessageContentMask, LldpSystemCapabilitiesMap, LogRecordMask, PasswordOptionsMask, PermissionType, PubSubConfigurationRefMask, TrustListValidationOptions, UadpDataSetMessageContentMask, UadpNetworkMessageContentMask, UserConfigurationMask
```
public abstract class AbstractOptionSetDataType<T extends Enum<T> & OptionSpecification,S extends Number,U extends AbstractOptionSetDataType<T,S,U,V>,V extends AbstractOptionSetDataType.AbstractBuilder<T>>
extends Object
implements OptionSetDataType<T,S>
```
This class is designed to be subtyped by Codegen classes only.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractOptionSetDataType.AbstractBuilder<T extends Enum<T> & OptionSpecification>` This class is designed to be subtyped by codegen classes only.

Nested classes/interfaces inherited from interface com.prosysopc.ua.UaOptionSet
UaOptionSet.Builder

Field Summary

Fields
Modifier and Type	Field and Description
`protected UaNodeId`	`baseDataTypeId`
`protected Class<S>`	`builtInTypeClass`
`protected BitField`	`delegate`
`protected Class<T>`	`optionClass`
`protected int`	`sizeInBits`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractOptionSetDataType(BitField delegate, Class<T> optionClass, Class<S> builtInTypeClass, UaNodeId baseDataTypeId, int sizeInBits)` Internal constructor, should only be called by Codegen code.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`S`	`asBuiltInType()` Returns the data as the built-in type from which type is inherited.
`protected static <T extends Enum<T> & OptionSpecification> BitField`	`computeBitField(AbstractOptionSetDataType<T,?,?,?>... values)`
`protected static BitField`	`computeBitField(BitField values)`
`protected static BitField`	`computeBitField(BitSet values)`
`protected static BitField`	`computeBitField(int... setBits)`
`protected static <T extends Enum<T> & BitPosition> BitField`	`computeBitField(Iterable<T> fields)`
`protected static <T extends Enum<T> & BitPosition> BitField`	`computeBitField(T... fields)`
`protected static BitField`	`computeBitFieldFixedSize(int size, int... setBits)`
`protected S`	`computeBuiltInTypeValue(Class<S> clazz, int size)` Builds the value in encodeable form.
`boolean`	`containsAll(U value)` Transforms the given value with `toSet()` and returns result of `UaOptionSet.containsAll(Iterable)`.
`boolean`	`equals(Object obj)`
`UaNodeId`	`getBaseTypeId()` Returns the base numeric DataTypeId, which matches the `OptionSetDataType.getBuiltInTypeClass()` and `OptionSetDataType.asBuiltInType()`.
`Class<S>`	`getBuiltInTypeClass()` Returns the class object for the built-in type.
`int`	`getSizeInBits()` Returns the size in bits.
`S`	`getValue()` Returns the "Value" of the OptionSet.
`int`	`hashCode()`
`boolean`	`isBitSet(int position)` Is bit set in position.
`V`	`toBuilder()` Creates a new `UaOptionSet.Builder` with set options that are set in this instance.
`Set<T>`	`toSet()` Returns a `Set` of the individual Options that are set in this OptionSet.
`String`	`toString()`

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

Methods inherited from interface com.prosysopc.ua.UaOptionSet
contains, containsAll, specification, toBitSet, toOptionsMap

- Field Detail
  - delegate
```
protected final BitField delegate
```
  - optionClass
```
protected final Class<T extends Enum<T> & OptionSpecification> optionClass
```
  - builtInTypeClass
```
protected final Class<S extends Number> builtInTypeClass
```
  - baseDataTypeId
```
protected final UaNodeId baseDataTypeId
```
  - sizeInBits
```
protected final int sizeInBits
```
- Constructor Detail
  - AbstractOptionSetDataType
```
protected AbstractOptionSetDataType(BitField delegate,
                                    Class<T> optionClass,
                                    Class<S> builtInTypeClass,
                                    UaNodeId baseDataTypeId,
                                    int sizeInBits)
```
    Internal constructor, should only be called by Codegen code.
- Method Detail
  - computeBitField
```
@SafeVarargs
protected static <T extends Enum<T> & OptionSpecification> BitField computeBitField(AbstractOptionSetDataType<T,?,?,?>... values)
```
  - computeBitField
```
protected static BitField computeBitField(BitField values)
```
  - computeBitField
```
protected static BitField computeBitField(BitSet values)
```
  - computeBitField
```
protected static BitField computeBitField(int... setBits)
```
  - computeBitField
```
protected static <T extends Enum<T> & BitPosition> BitField computeBitField(Iterable<T> fields)
```
  - computeBitField
```
protected static <T extends Enum<T> & BitPosition> BitField computeBitField(T... fields)
```
  - computeBitFieldFixedSize
```
protected static BitField computeBitFieldFixedSize(int size,
                                                   int... setBits)
```
  - asBuiltInType
```
public final S asBuiltInType()
```
    Description copied from interface: OptionSetDataType
    
    Returns the data as the built-in type from which type is inherited.
    
    Specified by:
    
    asBuiltInType in interface OptionSetDataType<T extends Enum<T> & OptionSpecification,S extends Number>
  - containsAll
```
public final boolean containsAll(U value)
```
    Transforms the given value with toSet() and returns result of UaOptionSet.containsAll(Iterable).
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getBaseTypeId
```
public final UaNodeId getBaseTypeId()
```
    Description copied from interface: OptionSetDataType
    
    Returns the base numeric DataTypeId, which matches the OptionSetDataType.getBuiltInTypeClass() and OptionSetDataType.asBuiltInType().
    
    Specified by:
    
    getBaseTypeId in interface OptionSetDataType<T extends Enum<T> & OptionSpecification,S extends Number>
  - getBuiltInTypeClass
```
public final Class<S> getBuiltInTypeClass()
```
    Description copied from interface: OptionSetDataType
    
    Returns the class object for the built-in type.
    
    Specified by:
    
    getBuiltInTypeClass in interface OptionSetDataType<T extends Enum<T> & OptionSpecification,S extends Number>
  - getSizeInBits
```
public final int getSizeInBits()
```
    Description copied from interface: OptionSetDataType
    
    Returns the size in bits. Typically this is one of the following: 8, 16, 32, 64.
    
    Specified by:
    
    getSizeInBits in interface OptionSetDataType<T extends Enum<T> & OptionSpecification,S extends Number>
  - getValue
```
public final S getValue()
```
    Description copied from interface: UaOptionSet
    
    Returns the "Value" of the OptionSet. For UInteger-based OptionSets, this is the BuiltInType representation of the value (i.e. the base type from which it inherits). For Structure-based OptionSets (subtypes of the OptionSet this is the OptionSet.getValue() field value (note that you must also check OptionSet.getValidBits() to know which bit positions are valid).
    
    Specified by:
    
    getValue in interface UaOptionSet
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isBitSet
```
public final 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
  - toBuilder
```
public V toBuilder()
```
    Description copied from interface: UaOptionSet
    
    Creates a new UaOptionSet.Builder with set options that are set in this instance.
    
    Specified by:
    
    toBuilder in interface UaOptionSet
  - toSet
```
public final Set<T> toSet()
```
    Returns a Set of the individual Options that are set in this OptionSet.
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object
  - computeBuiltInTypeValue
```
protected final S computeBuiltInTypeValue(Class<S> clazz,
                                          int size)
```
    Builds the value in encodeable form.

Class AbstractOptionSetDataType<T extends Enum<T> & OptionSpecification,S extends Number,U extends AbstractOptionSetDataType<T,S,U,V>,V extends AbstractOptionSetDataType.AbstractBuilder<T>>

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.prosysopc.ua.UaOptionSet

Field Detail

delegate

optionClass

builtInTypeClass

baseDataTypeId

sizeInBits

Constructor Detail

AbstractOptionSetDataType

Method Detail

computeBitField

computeBitField

computeBitField

computeBitField

computeBitField

computeBitField

computeBitFieldFixedSize

asBuiltInType

containsAll

equals

getBaseTypeId

getBuiltInTypeClass

getSizeInBits

getValue

hashCode

isBitSet

toBuilder

toSet

toString

computeBuiltInTypeValue