com.prosysopc.ua.stack.core

Class OptionSet

java.lang.Object

com.prosysopc.ua.stack.utils.AbstractStructure

com.prosysopc.ua.typedictionary.DynamicStructure

com.prosysopc.ua.stack.core.OptionSet

All Implemented Interfaces:

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

public class OptionSet
extends DynamicStructure
implements UaOptionSet, OptionSetStructure

Base for all OptionSets that are Structures (there are also UInteger-based OptionSets).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OptionSet.Builder Base for Structure-OptionSet builders.
static class	OptionSet.Fields The fields of the OptionSet Structure.

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

Field Summary

Fields

Modifier and Type	Field and Description
static OptionSetStructureSpecification	SPECIFICATION

Constructor Summary

Constructors

Modifier	Constructor and Description
	OptionSet()
	OptionSet(ByteString value, ByteString validBits)
protected	OptionSet(UaDataTypeSpecification specification)

Method Summary

Modifier and Type	Method and Description
OptionSet	clone() Clones the Structure.
boolean	contains(OptionSpecification... options) Returns true if the given option is set.
ByteString	getValidBits()
ByteString	getValue() Returns the "Value" of the OptionSet.
boolean	isBitSet(int position) Is bit set in position.
boolean	isValid(int bitPosition) Returns true if the bit position is set in the getValidBits().
boolean	isValid(OptionSpecification option) Returns true if the option exist (is part of OptionSetStructure.specification()) and it's position is set in the getValidBits().
void	set(FieldSpecification field, Object value) Sets a new value for a field.
void	setValid(int bitPosition, boolean valid) Sets or clears the bit in getValidBits() in the position.
void	setValid(OptionSpecification option, boolean valid) Sets or clears the bit in getValidBits() in the position.
void	setValidBits(ByteString validBits)
void	setValue(ByteString value)
OptionSetStructureSpecification	specification() Returns the specification of the given Structure.
OptionSet.Builder	toBuilder() Returns a builder with the data of this Structure pre-set.

Methods inherited from class com.prosysopc.ua.typedictionary.DynamicStructure

builder

Methods inherited from class com.prosysopc.ua.stack.utils.AbstractStructure

clear, equals, forEachField, forEachField, get, get, hashCode, indexGet, indexSet, set, toFieldNamesMap, toFieldNamesMap, toFieldsMap, toFieldsMap, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

Methods inherited from interface com.prosysopc.ua.UaOptionSet

containsAll, toBitSet, toOptionsMap

Field Detail

SPECIFICATION

public static final OptionSetStructureSpecification SPECIFICATION

Constructor Detail

OptionSet

public OptionSet()

OptionSet

public OptionSet(ByteString value,
                 ByteString validBits)

OptionSet

protected OptionSet(UaDataTypeSpecification specification)

Method Detail

clone

public OptionSet clone()

Description copied from class: AbstractStructure

Clones the Structure. This base implementation removes the CloneNotSupportedException as all Structures must be cloneable.

Specified by:

clone in interface Structure

Overrides:

clone in class DynamicStructure

contains

public boolean contains(OptionSpecification... options)

Description copied from interface: UaOptionSet

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

Specified by:

contains in interface UaOptionSet

getValidBits

public ByteString getValidBits()

getValue

public ByteString 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 getValue() field value (note that you must also check getValidBits() to know which bit positions are valid).

Specified by:

getValue in interface UaOptionSet

isBitSet

public 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

isValid

public final boolean isValid(int bitPosition)

Description copied from interface: OptionSetStructure

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

Specified by:

isValid in interface OptionSetStructure

isValid

public final boolean isValid(OptionSpecification option)

Description copied from interface: OptionSetStructure

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

Specified by:

isValid in interface OptionSetStructure

set

public void set(FieldSpecification field,
                Object value)

Description copied from interface: Structure

Sets a new value for a field. Note that the field must be an existing one i.e. one of the fields of Structure.specification(). Setting an Optional Field to null will make it not present for encoding. Setting a Field in an Union will unset other fields.

Specified by:

set in interface Structure

Overrides:

set in class AbstractStructure

Parameters:

field - specification of a field, must be one of the fields in the specification given by Structure.specification().

value - the value of the field (can be null)

setValid

public void setValid(int bitPosition,
                     boolean valid)

Description copied from interface: OptionSetStructure

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

Specified by:

setValid in interface OptionSetStructure

setValid

public void setValid(OptionSpecification option,
                     boolean valid)

Description copied from interface: OptionSetStructure

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

Specified by:

setValid in interface OptionSetStructure

setValidBits

public void setValidBits(ByteString validBits)

setValue

public void setValue(ByteString value)

specification

public 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 OptionSetStructure

Specified by:

specification in interface UaOptionSet

Overrides:

specification in class AbstractStructure

toBuilder

public OptionSet.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 OptionSetStructure

Specified by:

toBuilder in interface UaOptionSet

Overrides:

toBuilder in class AbstractStructure