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

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

Class DataTypeDescriptionTypeNode

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

All Implemented Interfaces:

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

public class DataTypeDescriptionTypeNode
extends BaseDataVariableTypeNode
implements DataTypeDescriptionType

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

DATA_TYPE_VERSION, DICTIONARY_FRAGMENT

Constructor Summary

Constructors

Constructor

Description

DataTypeDescriptionTypeNode(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 DataTypeDescriptionType.getDataTypeVersionNode().
org.eclipse.milo.opcua.stack.core.types.builtin.ByteString	getDictionaryFragment()	Get the local value of the DictionaryFragment Node.
PropertyTypeNode	getDictionaryFragmentNode()	Get the DictionaryFragment PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getDictionaryFragmentNodeAsync()	Asynchronous implementation of DataTypeDescriptionType.getDictionaryFragmentNode().
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.
org.eclipse.milo.opcua.stack.core.types.builtin.ByteString	readDictionaryFragment()	Read the value of the DictionaryFragment Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.ByteString>	readDictionaryFragmentAsync()	Get the value of the VariableNodeProperties.DictionaryFragment Property, if it exists.
void	setDataTypeVersion(String value)	Set the local value of the DataTypeVersion Node.
void	setDictionaryFragment(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString value)	Set the local value of the DictionaryFragment 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	writeDictionaryFragment(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString value)	Write a new value for the DictionaryFragment Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDictionaryFragmentAsync(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString dictionaryFragment)	Set the value of the VariableNodeProperties.DictionaryFragment Property, if it exists.

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

DataTypeDescriptionTypeNode

public DataTypeDescriptionTypeNode(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: DataTypeDescriptionType

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 DataTypeDescriptionType

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: DataTypeDescriptionType

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 DataTypeDescriptionType

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: DataTypeDescriptionType

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

Specified by:

readDataTypeVersion in interface DataTypeDescriptionType

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: DataTypeDescriptionType

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 DataTypeDescriptionType

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 DataTypeDescriptionType

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 DataTypeDescriptionType

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: DataTypeDescriptionType

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 DataTypeDescriptionType

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: DataTypeDescriptionType

Asynchronous implementation of DataTypeDescriptionType.getDataTypeVersionNode().

Specified by:

getDataTypeVersionNodeAsync in interface DataTypeDescriptionType

Returns:

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

getDictionaryFragment

public org.eclipse.milo.opcua.stack.core.types.builtin.ByteString getDictionaryFragment()
                                                                                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataTypeDescriptionType

Get the local value of the DictionaryFragment Node.

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

Specified by:

getDictionaryFragment in interface DataTypeDescriptionType

Returns:

the local value of the DictionaryFragment Node.

Throws:

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

setDictionaryFragment

public void setDictionaryFragment(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString value)
                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataTypeDescriptionType

Set the local value of the DictionaryFragment Node.

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

Specified by:

setDictionaryFragment in interface DataTypeDescriptionType

Parameters:

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

Throws:

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

readDictionaryFragment

public org.eclipse.milo.opcua.stack.core.types.builtin.ByteString readDictionaryFragment()
                                                                                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataTypeDescriptionType

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

Specified by:

readDictionaryFragment in interface DataTypeDescriptionType

Returns:

the ByteString value read from the server.

Throws:

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

writeDictionaryFragment

public void writeDictionaryFragment(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString value)
                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataTypeDescriptionType

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

Specified by:

writeDictionaryFragment in interface DataTypeDescriptionType

Parameters:

value - the ByteString value to write to the server.

Throws:

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

readDictionaryFragmentAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.ByteString> readDictionaryFragmentAsync()

Description copied from class: UaVariableNode

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

Specified by:

readDictionaryFragmentAsync in interface DataTypeDescriptionType

Overrides:

readDictionaryFragmentAsync in class UaVariableNode

Returns:

the value of the DictionaryFragment Property, if it exists.

See Also:

• VariableNodeProperties

writeDictionaryFragmentAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeDictionaryFragmentAsync(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString dictionaryFragment)

Description copied from class: UaVariableNode

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

Specified by:

writeDictionaryFragmentAsync in interface DataTypeDescriptionType

Overrides:

writeDictionaryFragmentAsync in class UaVariableNode

Parameters:

dictionaryFragment - the value to set.

Returns:

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

See Also:

• VariableNodeProperties

getDictionaryFragmentNode

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

Description copied from interface: DataTypeDescriptionType

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

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

Specified by:

getDictionaryFragmentNode in interface DataTypeDescriptionType

Returns:

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

getDictionaryFragmentNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getDictionaryFragmentNodeAsync()

Description copied from interface: DataTypeDescriptionType

Asynchronous implementation of DataTypeDescriptionType.getDictionaryFragmentNode().

Specified by:

getDictionaryFragmentNodeAsync in interface DataTypeDescriptionType

Returns:

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