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

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

Class DataTypeDictionaryTypeNode

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

All Implemented Interfaces:

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

public class DataTypeDictionaryTypeNode
extends BaseDataVariableTypeNode
implements DataTypeDictionaryType

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

DATA_TYPE_VERSION, DEPRECATED, NAMESPACE_URI

Constructor Summary

Constructors

Constructor

Description

DataTypeDictionaryTypeNode(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
String	getDataTypeVersion()	Get the local value of the DataTypeVersion Node.
PropertyTypeNode	getDataTypeVersionNode()	Get the DataTypeVersion PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getDataTypeVersionNodeAsync()	Asynchronous implementation of DataTypeDictionaryType.getDataTypeVersionNode().
Boolean	getDeprecated()	Get the local value of the Deprecated Node.
PropertyTypeNode	getDeprecatedNode()	Get the Deprecated PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getDeprecatedNodeAsync()	Asynchronous implementation of DataTypeDictionaryType.getDeprecatedNode().
String	getNamespaceUri()	Get the local value of the NamespaceUri Node.
PropertyTypeNode	getNamespaceUriNode()	Get the NamespaceUri PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getNamespaceUriNodeAsync()	Asynchronous implementation of DataTypeDictionaryType.getNamespaceUriNode().
String	readDataTypeVersion()	Read the value of the DataTypeVersion Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readDataTypeVersionAsync()	Get the value of the VariableNodeProperties.DataTypeVersion Property, if it exists.
Boolean	readDeprecated()	Read the value of the Deprecated Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readDeprecatedAsync()	An asynchronous implementation of DataTypeDictionaryType.readDeprecated().
String	readNamespaceUri()	Read the value of the NamespaceUri Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readNamespaceUriAsync()	An asynchronous implementation of DataTypeDictionaryType.readNamespaceUri().
void	setDataTypeVersion(String value)	Set the local value of the DataTypeVersion Node.
void	setDeprecated(Boolean value)	Set the local value of the Deprecated Node.
void	setNamespaceUri(String value)	Set the local value of the NamespaceUri Node.
void	writeDataTypeVersion(String value)	Write a new value for the DataTypeVersion Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDataTypeVersionAsync(String dataTypeVersion)	Set the value of the VariableNodeProperties.DataTypeVersion Property, if it exists.
void	writeDeprecated(Boolean value)	Write a new value for the Deprecated Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDeprecatedAsync(Boolean deprecated)	An asynchronous implementation of DataTypeDictionaryType.writeDeprecated(java.lang.Boolean).
void	writeNamespaceUri(String value)	Write a new value for the NamespaceUri Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeNamespaceUriAsync(String namespaceUri)	An asynchronous implementation of DataTypeDictionaryType.writeNamespaceUri(java.lang.String).

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, 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, 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

DataTypeDictionaryTypeNode

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

getDataTypeVersion

public String getDataTypeVersion()
                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataTypeDictionaryType

Get the local value of the DataTypeVersion Node.

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

Specified by:

getDataTypeVersion in interface DataTypeDictionaryType

Returns:

the local value of the DataTypeVersion Node.

Throws:

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

setDataTypeVersion

public void setDataTypeVersion(String value)
                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataTypeDictionaryType

Set the local value of the DataTypeVersion Node.

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

Specified by:

setDataTypeVersion in interface DataTypeDictionaryType

Parameters:

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

Throws:

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

readDataTypeVersion

public String readDataTypeVersion()
                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataTypeDictionaryType

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

Specified by:

readDataTypeVersion in interface DataTypeDictionaryType

Returns:

the String value read from the server.

Throws:

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

writeDataTypeVersion

public void writeDataTypeVersion(String value)
                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataTypeDictionaryType

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

Specified by:

writeDataTypeVersion in interface DataTypeDictionaryType

Parameters:

value - the String value to write to the server.

Throws:

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

readDataTypeVersionAsync

public CompletableFuture<? extends String> readDataTypeVersionAsync()

Description copied from class: UaVariableNode

Get the value of the VariableNodeProperties.DataTypeVersion Property, if it exists.

Specified by:

readDataTypeVersionAsync in interface DataTypeDictionaryType

Overrides:

readDataTypeVersionAsync in class UaVariableNode

Returns:

the value of the DataTypeVersion Property, if it exists.

See Also:

• VariableNodeProperties

writeDataTypeVersionAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeDataTypeVersionAsync(String dataTypeVersion)

Description copied from class: UaVariableNode

Set the value of the VariableNodeProperties.DataTypeVersion Property, if it exists.

Specified by:

writeDataTypeVersionAsync in interface DataTypeDictionaryType

Overrides:

writeDataTypeVersionAsync in class UaVariableNode

Parameters:

dataTypeVersion - the value to set.

Returns:

a CompletableFuture that completes with the StatusCode of the write operation.

See Also:

• VariableNodeProperties

getDataTypeVersionNode

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

Description copied from interface: DataTypeDictionaryType

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

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

Specified by:

getDataTypeVersionNode in interface DataTypeDictionaryType

Returns:

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

getDataTypeVersionNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getDataTypeVersionNodeAsync()

Description copied from interface: DataTypeDictionaryType

Asynchronous implementation of DataTypeDictionaryType.getDataTypeVersionNode().

Specified by:

getDataTypeVersionNodeAsync in interface DataTypeDictionaryType

Returns:

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

getNamespaceUri

public String getNamespaceUri()
                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataTypeDictionaryType

Get the local value of the NamespaceUri Node.

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

Specified by:

getNamespaceUri in interface DataTypeDictionaryType

Returns:

the local value of the NamespaceUri Node.

Throws:

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

setNamespaceUri

public void setNamespaceUri(String value)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataTypeDictionaryType

Set the local value of the NamespaceUri Node.

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

Specified by:

setNamespaceUri in interface DataTypeDictionaryType

Parameters:

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

Throws:

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

readNamespaceUri

public String readNamespaceUri()
                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataTypeDictionaryType

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

Specified by:

readNamespaceUri in interface DataTypeDictionaryType

Returns:

the String value read from the server.

Throws:

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

writeNamespaceUri

public void writeNamespaceUri(String value)
                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataTypeDictionaryType

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

Specified by:

writeNamespaceUri in interface DataTypeDictionaryType

Parameters:

value - the String value to write to the server.

Throws:

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

readNamespaceUriAsync

public CompletableFuture<? extends String> readNamespaceUriAsync()

Description copied from interface: DataTypeDictionaryType

An asynchronous implementation of DataTypeDictionaryType.readNamespaceUri().

Specified by:

readNamespaceUriAsync in interface DataTypeDictionaryType

Returns:

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

writeNamespaceUriAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeNamespaceUriAsync(String namespaceUri)

Description copied from interface: DataTypeDictionaryType

An asynchronous implementation of DataTypeDictionaryType.writeNamespaceUri(java.lang.String).

Specified by:

writeNamespaceUriAsync in interface DataTypeDictionaryType

Returns:

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

getNamespaceUriNode

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

Description copied from interface: DataTypeDictionaryType

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

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

Specified by:

getNamespaceUriNode in interface DataTypeDictionaryType

Returns:

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

getNamespaceUriNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getNamespaceUriNodeAsync()

Description copied from interface: DataTypeDictionaryType

Asynchronous implementation of DataTypeDictionaryType.getNamespaceUriNode().

Specified by:

getNamespaceUriNodeAsync in interface DataTypeDictionaryType

Returns:

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

getDeprecated

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

Description copied from interface: DataTypeDictionaryType

Get the local value of the Deprecated Node.

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

Specified by:

getDeprecated in interface DataTypeDictionaryType

Returns:

the local value of the Deprecated Node.

Throws:

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

setDeprecated

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

Description copied from interface: DataTypeDictionaryType

Set the local value of the Deprecated Node.

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

Specified by:

setDeprecated in interface DataTypeDictionaryType

Parameters:

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

Throws:

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

readDeprecated

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

Description copied from interface: DataTypeDictionaryType

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

Specified by:

readDeprecated in interface DataTypeDictionaryType

Returns:

the Boolean value read from the server.

Throws:

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

writeDeprecated

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

Description copied from interface: DataTypeDictionaryType

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

Specified by:

writeDeprecated in interface DataTypeDictionaryType

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.

readDeprecatedAsync

public CompletableFuture<? extends Boolean> readDeprecatedAsync()

Description copied from interface: DataTypeDictionaryType

An asynchronous implementation of DataTypeDictionaryType.readDeprecated().

Specified by:

readDeprecatedAsync in interface DataTypeDictionaryType

Returns:

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

writeDeprecatedAsync

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

Description copied from interface: DataTypeDictionaryType

An asynchronous implementation of DataTypeDictionaryType.writeDeprecated(java.lang.Boolean).

Specified by:

writeDeprecatedAsync in interface DataTypeDictionaryType

Returns:

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

getDeprecatedNode

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

Description copied from interface: DataTypeDictionaryType

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

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

Specified by:

getDeprecatedNode in interface DataTypeDictionaryType

Returns:

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

getDeprecatedNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getDeprecatedNodeAsync()

Description copied from interface: DataTypeDictionaryType

Asynchronous implementation of DataTypeDictionaryType.getDeprecatedNode().

Specified by:

getDeprecatedNodeAsync in interface DataTypeDictionaryType

Returns:

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