com.prosysopc.ua.typedictionary

Interface OptionSetStructure

All Superinterfaces:

BitField, Cloneable, IEncodeable, Structure, UaNamespaceTranslateable<Structure>, UaOptionSet

All Known Implementing Classes:

OptionSet

public interface OptionSetStructure
extends Structure, UaOptionSet

Models 'OptionSet' Structure types, who are both Structures and have OptionSetValues Property.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	OptionSetStructure.Builder Builder for OptionSetStructure.

Nested classes/interfaces inherited from interface com.prosysopc.ua.stack.builtintypes.Structure

Structure.MapKind<T>

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

UaNamespaceTranslateable.Context

Method Summary

Modifier and Type	Method and Description
default boolean	isValid(int bitPosition) Returns true if the bit position is set in the OptionSet.getValidBits().
default boolean	isValid(OptionSpecification option) Returns true if the option exist (is part of specification()) and it's position is set in the OptionSet.getValidBits().
void	setValid(int bitPosition, boolean valid) Sets or clears the bit in OptionSet.getValidBits() in the position.
void	setValid(OptionSpecification option, boolean valid) Sets or clears the bit in OptionSet.getValidBits() in the position.
OptionSetStructureSpecification	specification() Returns the specification of the given Structure.
OptionSetStructure.Builder	toBuilder() Returns a builder with the data of this Structure pre-set.

Methods inherited from interface com.prosysopc.ua.stack.builtintypes.Structure

clear, clone, forEachField, forEachField, get, get, reduceFields, reduceFields, set, set, toFieldNamesMap, toFieldNamesMap, toFieldsMap, toFieldsMap, toMap, withTranslatedNamespaces

Methods inherited from interface com.prosysopc.ua.UaOptionSet

contains, containsAll, getValue, toBitSet, toOptionsMap

Methods inherited from interface com.prosysopc.ua.BitField

isBitSet

Method Detail

isValid

default boolean isValid(int bitPosition)

Returns true if the bit position is set in the OptionSet.getValidBits().

isValid

default boolean isValid(OptionSpecification option)

Returns true if the option exist (is part of specification()) and it's position is set in the OptionSet.getValidBits().

setValid

void setValid(int bitPosition,
              boolean valid)

Sets or clears the bit in OptionSet.getValidBits() in the position. Does nothing if the given position is not one of the specification() option(s) position.

setValid

void setValid(OptionSpecification option,
              boolean valid)

Sets or clears the bit in OptionSet.getValidBits() in the position. Does nothing if the given option is not part of specification().

specification

OptionSetStructureSpecification specification()

Description copied from interface: Structure

Returns the specification of the given Structure. Can be used to dynamically display the fields of the Structure.

Specified by:

specification in interface Structure

Specified by:

specification in interface UaOptionSet

toBuilder

OptionSetStructure.Builder toBuilder()

Description copied from interface: Structure

Returns a builder with the data of this Structure pre-set. The returned builder shall return instances of the same #getClass() as this one.

Specified by:

toBuilder in interface Structure

Specified by:

toBuilder in interface UaOptionSet