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

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

Class SelectionListTypeNode

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

All Implemented Interfaces:

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

public class SelectionListTypeNode
extends BaseDataVariableTypeNode
implements SelectionListType

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

RESTRICT_TO_LIST, SELECTION_DESCRIPTIONS, SELECTIONS

Constructor Summary

Constructors

Constructor

Description

SelectionListTypeNode(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	getRestrictToList()	Get the local value of the RestrictToList Node.
PropertyTypeNode	getRestrictToListNode()	Get the RestrictToList PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getRestrictToListNodeAsync()	Asynchronous implementation of SelectionListType.getRestrictToListNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]	getSelectionDescriptions()	Get the local value of the SelectionDescriptions Node.
PropertyTypeNode	getSelectionDescriptionsNode()	Get the SelectionDescriptions PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getSelectionDescriptionsNodeAsync()	Asynchronous implementation of SelectionListType.getSelectionDescriptionsNode().
Object[]	getSelections()	Get the local value of the Selections Node.
PropertyTypeNode	getSelectionsNode()	Get the Selections PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getSelectionsNodeAsync()	Asynchronous implementation of SelectionListType.getSelectionsNode().
Boolean	readRestrictToList()	Read the value of the RestrictToList Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readRestrictToListAsync()	An asynchronous implementation of SelectionListType.readRestrictToList().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]	readSelectionDescriptions()	Read the value of the SelectionDescriptions Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]>	readSelectionDescriptionsAsync()	An asynchronous implementation of SelectionListType.readSelectionDescriptions().
Object[]	readSelections()	Read the value of the Selections Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Object[]>	readSelectionsAsync()	An asynchronous implementation of SelectionListType.readSelections().
void	setRestrictToList(Boolean value)	Set the local value of the RestrictToList Node.
void	setSelectionDescriptions(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] value)	Set the local value of the SelectionDescriptions Node.
void	setSelections(Object[] value)	Set the local value of the Selections Node.
void	writeRestrictToList(Boolean value)	Write a new value for the RestrictToList Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeRestrictToListAsync(Boolean restrictToList)	An asynchronous implementation of SelectionListType.writeRestrictToList(java.lang.Boolean).
void	writeSelectionDescriptions(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] value)	Write a new value for the SelectionDescriptions Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSelectionDescriptionsAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] selectionDescriptions)	An asynchronous implementation of SelectionListType.writeSelectionDescriptions(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]).
void	writeSelections(Object[] value)	Write a new value for the Selections Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSelectionsAsync(Object[] selections)	An asynchronous implementation of SelectionListType.writeSelections(java.lang.Object[]).

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

SelectionListTypeNode

public SelectionListTypeNode(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

getSelections

public Object[] getSelections()
                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: SelectionListType

Get the local value of the Selections Node.

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

Specified by:

getSelections in interface SelectionListType

Returns:

the local value of the Selections Node.

Throws:

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

setSelections

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

Description copied from interface: SelectionListType

Set the local value of the Selections Node.

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

Specified by:

setSelections in interface SelectionListType

Parameters:

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

Throws:

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

readSelections

public Object[] readSelections()
                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: SelectionListType

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

Specified by:

readSelections in interface SelectionListType

Returns:

the Object value read from the server.

Throws:

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

writeSelections

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

Description copied from interface: SelectionListType

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

Specified by:

writeSelections in interface SelectionListType

Parameters:

value - the Object value to write to the server.

Throws:

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

readSelectionsAsync

public CompletableFuture<? extends Object[]> readSelectionsAsync()

Description copied from interface: SelectionListType

An asynchronous implementation of SelectionListType.readSelections().

Specified by:

readSelectionsAsync in interface SelectionListType

Returns:

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

writeSelectionsAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSelectionsAsync(Object[] selections)

Description copied from interface: SelectionListType

An asynchronous implementation of SelectionListType.writeSelections(java.lang.Object[]).

Specified by:

writeSelectionsAsync in interface SelectionListType

Returns:

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

getSelectionsNode

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

Description copied from interface: SelectionListType

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

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

Specified by:

getSelectionsNode in interface SelectionListType

Returns:

the Selections 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.

getSelectionsNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getSelectionsNodeAsync()

Description copied from interface: SelectionListType

Asynchronous implementation of SelectionListType.getSelectionsNode().

Specified by:

getSelectionsNodeAsync in interface SelectionListType

Returns:

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

getSelectionDescriptions

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

Description copied from interface: SelectionListType

Get the local value of the SelectionDescriptions Node.

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

Specified by:

getSelectionDescriptions in interface SelectionListType

Returns:

the local value of the SelectionDescriptions Node.

Throws:

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

setSelectionDescriptions

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

Description copied from interface: SelectionListType

Set the local value of the SelectionDescriptions Node.

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

Specified by:

setSelectionDescriptions in interface SelectionListType

Parameters:

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

Throws:

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

readSelectionDescriptions

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

Description copied from interface: SelectionListType

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

Specified by:

readSelectionDescriptions in interface SelectionListType

Returns:

the LocalizedText value read from the server.

Throws:

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

writeSelectionDescriptions

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

Description copied from interface: SelectionListType

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

Specified by:

writeSelectionDescriptions in interface SelectionListType

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.

readSelectionDescriptionsAsync

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

Description copied from interface: SelectionListType

An asynchronous implementation of SelectionListType.readSelectionDescriptions().

Specified by:

readSelectionDescriptionsAsync in interface SelectionListType

Returns:

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

writeSelectionDescriptionsAsync

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

Description copied from interface: SelectionListType

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

Specified by:

writeSelectionDescriptionsAsync in interface SelectionListType

Returns:

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

getSelectionDescriptionsNode

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

Description copied from interface: SelectionListType

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

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

Specified by:

getSelectionDescriptionsNode in interface SelectionListType

Returns:

the SelectionDescriptions 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.

getSelectionDescriptionsNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getSelectionDescriptionsNodeAsync()

Description copied from interface: SelectionListType

Asynchronous implementation of SelectionListType.getSelectionDescriptionsNode().

Specified by:

getSelectionDescriptionsNodeAsync in interface SelectionListType

Returns:

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

getRestrictToList

public Boolean getRestrictToList()
                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: SelectionListType

Get the local value of the RestrictToList Node.

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

Specified by:

getRestrictToList in interface SelectionListType

Returns:

the local value of the RestrictToList Node.

Throws:

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

setRestrictToList

public void setRestrictToList(Boolean value)
                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: SelectionListType

Set the local value of the RestrictToList Node.

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

Specified by:

setRestrictToList in interface SelectionListType

Parameters:

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

Throws:

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

readRestrictToList

public Boolean readRestrictToList()
                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: SelectionListType

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

Specified by:

readRestrictToList in interface SelectionListType

Returns:

the Boolean value read from the server.

Throws:

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

writeRestrictToList

public void writeRestrictToList(Boolean value)
                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: SelectionListType

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

Specified by:

writeRestrictToList in interface SelectionListType

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.

readRestrictToListAsync

public CompletableFuture<? extends Boolean> readRestrictToListAsync()

Description copied from interface: SelectionListType

An asynchronous implementation of SelectionListType.readRestrictToList().

Specified by:

readRestrictToListAsync in interface SelectionListType

Returns:

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

writeRestrictToListAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeRestrictToListAsync(Boolean restrictToList)

Description copied from interface: SelectionListType

An asynchronous implementation of SelectionListType.writeRestrictToList(java.lang.Boolean).

Specified by:

writeRestrictToListAsync in interface SelectionListType

Returns:

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

getRestrictToListNode

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

Description copied from interface: SelectionListType

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

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

Specified by:

getRestrictToListNode in interface SelectionListType

Returns:

the RestrictToList 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.

getRestrictToListNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getRestrictToListNodeAsync()

Description copied from interface: SelectionListType

Asynchronous implementation of SelectionListType.getRestrictToListNode().

Specified by:

getRestrictToListNodeAsync in interface SelectionListType

Returns:

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