Module org.eclipse.milo.opcua.sdk.client

Package org.eclipse.milo.opcua.sdk.client.model.variables

Class OptionSetTypeNode

java.lang.Object

org.eclipse.milo.opcua.sdk.client.nodes.UaNode

org.eclipse.milo.opcua.sdk.client.nodes.UaVariableNode

org.eclipse.milo.opcua.sdk.client.model.variables.BaseVariableTypeNode

org.eclipse.milo.opcua.sdk.client.model.variables.BaseDataVariableTypeNode

org.eclipse.milo.opcua.sdk.client.model.variables.OptionSetTypeNode

All Implemented Interfaces:

BaseDataVariableType, BaseVariableType, OptionSetType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode

public class OptionSetTypeNode
extends BaseDataVariableTypeNode
implements OptionSetType

Field Summary

Fields inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaNode

client

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.variables.OptionSetType

BIT_MASK, OPTION_SET_VALUES

Constructor Summary

Constructors

Constructor

Description

OptionSetTypeNode(OpcUaClient client, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId, org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass, org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] rolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions, org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions, org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType, Integer valueRank, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel, Double minimumSamplingInterval, Boolean historizing, org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx)

Method Summary

Modifier and Type	Method	Description
Boolean[]	getBitMask()	Get the local value of the BitMask Node.
PropertyTypeNode	getBitMaskNode()	Get the BitMask PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getBitMaskNodeAsync()	Asynchronous implementation of OptionSetType.getBitMaskNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]	getOptionSetValues()	Get the local value of the OptionSetValues Node.
PropertyTypeNode	getOptionSetValuesNode()	Get the OptionSetValues PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getOptionSetValuesNodeAsync()	Asynchronous implementation of OptionSetType.getOptionSetValuesNode().
Boolean[]	readBitMask()	Read the value of the BitMask Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean[]>	readBitMaskAsync()	An asynchronous implementation of OptionSetType.readBitMask().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]	readOptionSetValues()	Read the value of the OptionSetValues Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]>	readOptionSetValuesAsync()	An asynchronous implementation of OptionSetType.readOptionSetValues().
void	setBitMask(Boolean[] value)	Set the local value of the BitMask Node.
void	setOptionSetValues(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] value)	Set the local value of the OptionSetValues Node.
void	writeBitMask(Boolean[] value)	Write a new value for the BitMask Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeBitMaskAsync(Boolean[] bitMask)	An asynchronous implementation of OptionSetType.writeBitMask(java.lang.Boolean[]).
void	writeOptionSetValues(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] value)	Write a new value for the OptionSetValues Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeOptionSetValuesAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] optionSetValues)	An asynchronous implementation of OptionSetType.writeOptionSetValues(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]).

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaVariableNode

getAccessLevel, getAccessLevelEx, getArrayDimensions, getAttributeValue, getDataType, getHistorizing, getMinimumSamplingInterval, getTypeDefinition, getTypeDefinitionAsync, getUserAccessLevel, getValue, getValueRank, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readAccessLevel, readAccessLevelEx, readAllowNullsAsync, readArrayDimensions, readDataType, readDataTypeVersionAsync, readDictionaryFragmentAsync, readEngineeringUnitsAsync, readHistorizing, readLocalTimeAsync, readMaxArrayLengthAsync, readMaxStringLengthAsync, readMinimumSamplingInterval, readNodeVersionAsync, readUserAccessLevel, readValue, readValueAsTextAsync, readValueRank, setAccessLevel, setAccessLevelEx, setArrayDimensions, setAttributeValue, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValue, setValueRank, writeAccessLevel, writeAccessLevelEx, writeAllowNullsAsync, writeArrayDimensions, writeDataType, writeDataTypeVersionAsync, writeDictionaryFragmentAsync, writeEngineeringUnitsAsync, writeHistorizing, writeLocalTimeAsync, writeMaxArrayLengthAsync, writeMaxStringLengthAsync, writeMinimumSamplingInterval, writeNodeVersionAsync, writeUserAccessLevel, writeValue, writeValue, writeValueAsTextAsync, writeValueRank

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaNode

browse, browse, browseAsync, browseAsync, browseNodes, browseNodes, browseNodesAsync, browseNodesAsync, canonicalize, cast, findMemberNodeId, getAccessRestrictions, getBrowseName, getComponentAsync, getDescription, getDisplayName, getMemberNodeAsync, getNodeClass, getNodeId, getProperty, getPropertyNodeAsync, getPropertyNodeAsync, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, invalidate, readAccessRestrictions, readAttribute, readAttributeAsync, readBrowseName, readDescription, readDisplayName, readNamespaceIndex, readNodeClass, readNodeId, readProperty, readRolePermissions, readUserRolePermissions, readUserWriteMask, readWriteMask, refresh, refreshAsync, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setProperty, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask, synchronize, synchronizeAsync, writeAccessRestrictions, writeAttribute, writeAttributeAsync, writeBrowseName, writeDescription, writeDisplayName, writeNodeClass, writeNodeId, writeProperty, writeRolePermissions, writeUserRolePermissions, writeUserWriteMask, writeWriteMask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.Node

getAccessRestrictions, getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask

Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.VariableNode

getAccessLevel, getAccessLevelEx, getArrayDimensions, getDataType, getHistorizing, getMinimumSamplingInterval, getUserAccessLevel, getValue, getValueRank, setAccessLevel, setAccessLevelEx, setArrayDimensions, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValueRank

Constructor Details

OptionSetTypeNode

public OptionSetTypeNode(OpcUaClient client,
 org.eclipse.milo.opcua.stack.core.types.builtin.NodeId nodeId,
 org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass nodeClass,
 org.eclipse.milo.opcua.stack.core.types.builtin.QualifiedName browseName,
 org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText displayName,
 org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText description,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger writeMask,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger userWriteMask,
 org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] rolePermissions,
 org.eclipse.milo.opcua.stack.core.types.structured.RolePermissionType[] userRolePermissions,
 org.eclipse.milo.opcua.stack.core.types.structured.AccessRestrictionType accessRestrictions,
 org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value,
 org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType,
 Integer valueRank,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel,
 Double minimumSamplingInterval,
 Boolean historizing,
 org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx)

Method Details

getOptionSetValues

public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] getOptionSetValues()
                                                                                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: OptionSetType

Get the local value of the OptionSetValues Node.

The returned value is the last seen; it is not read live from the server.

Specified by:

getOptionSetValues in interface OptionSetType

Returns:

the local value of the OptionSetValues Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the OptionSetValues Node.

setOptionSetValues

public void setOptionSetValues(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] value)
                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: OptionSetType

Set the local value of the OptionSetValues Node.

The value is only updated locally; it is not written to the server.

Specified by:

setOptionSetValues in interface OptionSetType

Parameters:

value - the local value to set for the OptionSetValues Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the OptionSetValues Node.

readOptionSetValues

public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] readOptionSetValues()
                                                                                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: OptionSetType

Read the value of the OptionSetValues Node from the server and update the local value if the operation succeeds.

Specified by:

readOptionSetValues in interface OptionSetType

Returns:

the LocalizedText value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeOptionSetValues

public void writeOptionSetValues(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] value)
                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: OptionSetType

Write a new value for the OptionSetValues Node to the server and update the local value if the operation succeeds.

Specified by:

writeOptionSetValues in interface OptionSetType

Parameters:

value - the LocalizedText value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readOptionSetValuesAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]> readOptionSetValuesAsync()

Description copied from interface: OptionSetType

An asynchronous implementation of OptionSetType.readOptionSetValues().

Specified by:

readOptionSetValuesAsync in interface OptionSetType

Returns:

a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

writeOptionSetValuesAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeOptionSetValuesAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] optionSetValues)

Description copied from interface: OptionSetType

An asynchronous implementation of OptionSetType.writeOptionSetValues(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]).

Specified by:

writeOptionSetValuesAsync in interface OptionSetType

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getOptionSetValuesNode

public PropertyTypeNode getOptionSetValuesNode()
                                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: OptionSetType

Get the OptionSetValues PropertyType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Specified by:

getOptionSetValuesNode in interface OptionSetType

Returns:

the OptionSetValues PropertyType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getOptionSetValuesNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getOptionSetValuesNodeAsync()

Description copied from interface: OptionSetType

Asynchronous implementation of OptionSetType.getOptionSetValuesNode().

Specified by:

getOptionSetValuesNodeAsync in interface OptionSetType

Returns:

a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

getBitMask

public Boolean[] getBitMask()
                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: OptionSetType

Get the local value of the BitMask Node.

The returned value is the last seen; it is not read live from the server.

Specified by:

getBitMask in interface OptionSetType

Returns:

the local value of the BitMask Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the BitMask Node.

setBitMask

public void setBitMask(Boolean[] value)
                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: OptionSetType

Set the local value of the BitMask Node.

The value is only updated locally; it is not written to the server.

Specified by:

setBitMask in interface OptionSetType

Parameters:

value - the local value to set for the BitMask Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the BitMask Node.

readBitMask

public Boolean[] readBitMask()
                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: OptionSetType

Read the value of the BitMask Node from the server and update the local value if the operation succeeds.

Specified by:

readBitMask in interface OptionSetType

Returns:

the Boolean value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeBitMask

public void writeBitMask(Boolean[] value)
                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: OptionSetType

Write a new value for the BitMask Node to the server and update the local value if the operation succeeds.

Specified by:

writeBitMask in interface OptionSetType

Parameters:

value - the Boolean value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readBitMaskAsync

public CompletableFuture<? extends Boolean[]> readBitMaskAsync()

Description copied from interface: OptionSetType

An asynchronous implementation of OptionSetType.readBitMask().

Specified by:

readBitMaskAsync in interface OptionSetType

Returns:

a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

writeBitMaskAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeBitMaskAsync(Boolean[] bitMask)

Description copied from interface: OptionSetType

An asynchronous implementation of OptionSetType.writeBitMask(java.lang.Boolean[]).

Specified by:

writeBitMaskAsync in interface OptionSetType

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getBitMaskNode

public PropertyTypeNode getBitMaskNode()
                                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: OptionSetType

Get the BitMask PropertyType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Specified by:

getBitMaskNode in interface OptionSetType

Returns:

the BitMask PropertyType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getBitMaskNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getBitMaskNodeAsync()

Description copied from interface: OptionSetType

Asynchronous implementation of OptionSetType.getBitMaskNode().

Specified by:

getBitMaskNodeAsync in interface OptionSetType

Returns:

a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.