com.prosysopc.ua

Interface UaOptionSet

All Superinterfaces:

BitField

All Known Subinterfaces:

ByteOptionSetDataType<T>, OptionSetDataType<T,S>, OptionSetStructure, UInt16OptionSetDataType<T>, UInt32OptionSetDataType<T>, UInt64OptionSetDataType<T>

All Known Implementing Classes:

AbstractOptionSetDataType, AccessLevelExType, AccessLevelType, AccessRestrictionType, AlarmMask, AttributeWriteMask, DataSetFieldContentMask, DataSetFieldFlags, DynamicUIntOptionSet, EventNotifierType, JsonDataSetMessageContentMask, JsonNetworkMessageContentMask, LldpSystemCapabilitiesMap, LogRecordMask, OptionSet, PasswordOptionsMask, PermissionType, PubSubConfigurationRefMask, TrustListValidationOptions, UadpDataSetMessageContentMask, UadpNetworkMessageContentMask, UserConfigurationMask

public interface UaOptionSet
extends BitField

Interface for all UInteger and 'OptionSet-Structure' based OptionSet implementations.While it doesn't implement Set, it can be thought to be a Set of Options (that can be obtained via specification() + OptionSetSpecification.getOptions(). Instances can be converted to Set via the #toSet().

This interface is sealed, only SDK/Codegen shall create implementations of this interface. Implementations other than the OptionSet are immutable. Instances can be constructed via OptionSetSpecification.toInstanceBuilder().

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	UaOptionSet.Builder Interface for all Builders that will create UaOptionSet instances.

Method Summary

Modifier and Type	Method and Description
default boolean	contains(OptionSpecification... options) Returns true if the given option is set.
default boolean	containsAll(Iterable<? extends OptionSpecification> options) Returns true if the given options are set in the builder, false otherwise.
Object	getValue() Returns the "Value" of the OptionSet.
OptionSetSpecification	specification() Returns the specification of this UaOptionSet.
default BitSet	toBitSet() Returns a BitSet representation of this OptionSet (set options -> set bits).
UaOptionSet.Builder	toBuilder() Creates a new UaOptionSet.Builder with set options that are set in this instance.
default Map<OptionSpecification,Boolean>	toOptionsMap() Splits this UaOptionSet to a Map where keys are the OptionSetSpecification (from specification()) and values as-if #contains(OptionSpecification) would have been called per each field.

Methods inherited from interface com.prosysopc.ua.BitField

isBitSet

Method Detail

contains

default boolean contains(OptionSpecification... options)

Returns true if the given option is set. In OptionSet structure the option can only be set if it is also marked as valid per OptionSet.getValidBits().

containsAll

default boolean containsAll(Iterable<? extends OptionSpecification> options)

Returns true if the given options are set in the builder, false otherwise.

getValue

Object getValue()

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).

specification

OptionSetSpecification specification()

Returns the specification of this UaOptionSet. This can be used for generic procesing of the OptionSetSpecification.getOptions().

toBitSet

default BitSet toBitSet()

Returns a BitSet representation of this OptionSet (set options -> set bits). Note that modifying the returned BitSet wont modify this object.

toBuilder

UaOptionSet.Builder toBuilder()

Creates a new UaOptionSet.Builder with set options that are set in this instance.

toOptionsMap

default Map<OptionSpecification,Boolean> toOptionsMap()

Splits this UaOptionSet to a Map where keys are the OptionSetSpecification (from specification()) and values as-if #contains(OptionSpecification) would have been called per each field. The iteration order of the Map is the order of the options. The returned Map is unmodifiable.