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

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

Class UaDataTypeNode

java.lang.Object

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

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

All Implemented Interfaces:

org.eclipse.milo.opcua.sdk.core.nodes.DataTypeNode, org.eclipse.milo.opcua.sdk.core.nodes.Node

public class UaDataTypeNode
extends UaNode
implements org.eclipse.milo.opcua.sdk.core.nodes.DataTypeNode

Field Summary

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

client

Constructor Summary

Constructors

Constructor	Description
UaDataTypeNode(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, Boolean isAbstract)	Construct a UaDataTypeNode using only attributes defined prior to OPC UA 1.04.
UaDataTypeNode(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, Boolean isAbstract, org.eclipse.milo.opcua.stack.core.types.structured.DataTypeDefinition dataTypeDefinition)	Construct a UaDataTypeNode using all attributes, including those defined by OPC UA 1.04.

Method Summary

Modifier and Type	Method	Description
protected org.eclipse.milo.opcua.stack.core.types.builtin.DataValue	getAttributeValue(org.eclipse.milo.opcua.stack.core.AttributeId attributeId)
@Nullable org.eclipse.milo.opcua.stack.core.types.structured.DataTypeDefinition	getDataTypeDefinition()
Boolean	getIsAbstract()
@Nullable org.eclipse.milo.opcua.stack.core.types.structured.DataTypeDefinition	readDataTypeDefinition()	Read the DataTypeDefinition attribute for this Node from the server and update the local attribute if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]>	readEnumStringsAsync()	Get the value of the DataTypeNodeProperties.EnumStrings Property, if it exists.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.EnumValueType[]>	readEnumValuesAsync()	Get the value of the DataTypeNodeProperties.EnumValues Property, if it exists.
Boolean	readIsAbstract()	Read the IsAbstract attribute for this Node from the server and update the local attribute if the operation succeeds.
CompletableFuture<? extends String>	readNodeVersionAsync()	Get the value of the DataTypeNodeProperties.NodeVersion Property, if it exists.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]>	readOptionSetValuesAsync()	Get the value of the DataTypeNodeProperties.OptionSetValues Property, if it exists.
protected void	setAttributeValue(org.eclipse.milo.opcua.stack.core.AttributeId attributeId, org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value)
void	setDataTypeDefinition(org.eclipse.milo.opcua.stack.core.types.structured.DataTypeDefinition dataTypeDefinition)
void	setIsAbstract(Boolean isAbstract)
void	writeDataTypeDefinition(org.eclipse.milo.opcua.stack.core.types.structured.DataTypeDefinition dataTypeDefinition)	Write a new DataTypeDefinition attribute for this Node to the server and update the local attribute if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeEnumStringsAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] enumStrings)	Set the value of the EnumStrings Property, if it exists.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeEnumValuesAsync(org.eclipse.milo.opcua.stack.core.types.structured.EnumValueType[] enumValues)	Set the value of the DataTypeNodeProperties.EnumValues Property, if it exists.
void	writeIsAbstract(Boolean isAbstract)	Write a new IsAbstract attribute for this Node to the server and update the local attribute if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeNodeVersionAsync(String nodeVersion)	Set the value of the DataTypeNodeProperties.NodeVersion Property, if it exists.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeOptionSetValuesAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] optionSetValues)	Set the value of the DataTypeNodeProperties.OptionSetValues Property, if it exists.

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

Constructor Details

UaDataTypeNode

public UaDataTypeNode(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,
 Boolean isAbstract)

Construct a UaDataTypeNode using only attributes defined prior to OPC UA 1.04.

UaDataTypeNode

public UaDataTypeNode(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,
 Boolean isAbstract,
 org.eclipse.milo.opcua.stack.core.types.structured.DataTypeDefinition dataTypeDefinition)

Construct a UaDataTypeNode using all attributes, including those defined by OPC UA 1.04.

Method Details

getIsAbstract

public Boolean getIsAbstract()

The returned attribute is the most recently seen value; it is not read live from the server.

Specified by:

getIsAbstract in interface org.eclipse.milo.opcua.sdk.core.nodes.DataTypeNode

See Also:

• readIsAbstract()

getDataTypeDefinition

public @Nullable org.eclipse.milo.opcua.stack.core.types.structured.DataTypeDefinition getDataTypeDefinition()

The returned attribute is the most recently seen value; it is not read live from the server.

Specified by:

getDataTypeDefinition in interface org.eclipse.milo.opcua.sdk.core.nodes.DataTypeNode

See Also:

• readDataTypeDefinition()

setIsAbstract

public void setIsAbstract(Boolean isAbstract)

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

Specified by:

setIsAbstract in interface org.eclipse.milo.opcua.sdk.core.nodes.DataTypeNode

See Also:

• writeIsAbstract(Boolean)

setDataTypeDefinition

public void setDataTypeDefinition(org.eclipse.milo.opcua.stack.core.types.structured.DataTypeDefinition dataTypeDefinition)

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

Specified by:

setDataTypeDefinition in interface org.eclipse.milo.opcua.sdk.core.nodes.DataTypeNode

See Also:

• writeDataTypeDefinition(DataTypeDefinition)

readIsAbstract

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

Read the IsAbstract attribute for this Node from the server and update the local attribute if the operation succeeds.

Returns:

the Boolean read from the server.

Throws:

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

readDataTypeDefinition

public @Nullable org.eclipse.milo.opcua.stack.core.types.structured.DataTypeDefinition readDataTypeDefinition()
                                                                                                       throws org.eclipse.milo.opcua.stack.core.UaException

Read the DataTypeDefinition attribute for this Node from the server and update the local attribute if the operation succeeds.

Returns:

the DataTypeDefinition read from the server.

Throws:

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

writeIsAbstract

public void writeIsAbstract(Boolean isAbstract)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Write a new IsAbstract attribute for this Node to the server and update the local attribute if the operation succeeds.

Parameters:

isAbstract - the Boolean to write to the server.

Throws:

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

writeDataTypeDefinition

public void writeDataTypeDefinition(org.eclipse.milo.opcua.stack.core.types.structured.DataTypeDefinition dataTypeDefinition)
                             throws org.eclipse.milo.opcua.stack.core.UaException

Write a new DataTypeDefinition attribute for this Node to the server and update the local attribute if the operation succeeds.

Parameters:

dataTypeDefinition - the DataTypeDefinition to write to the server.

Throws:

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

readNodeVersionAsync

public CompletableFuture<? extends String> readNodeVersionAsync()

Get the value of the DataTypeNodeProperties.NodeVersion Property, if it exists.

Returns:

the value of the NodeVersion Property, if it exists.

See Also:

• DataTypeNodeProperties

readEnumStringsAsync

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

Get the value of the DataTypeNodeProperties.EnumStrings Property, if it exists.

Returns:

the value of the EnumStrings Property, if it exists.

See Also:

• DataTypeNodeProperties

readEnumValuesAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.EnumValueType[]> readEnumValuesAsync()

Get the value of the DataTypeNodeProperties.EnumValues Property, if it exists.

Returns:

the value of the EnumValues Property, if it exists.

See Also:

• DataTypeNodeProperties

readOptionSetValuesAsync

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

Get the value of the DataTypeNodeProperties.OptionSetValues Property, if it exists.

Returns:

the value of the OptionSetValues Property, if it exists.

See Also:

• DataTypeNodeProperties

writeNodeVersionAsync

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

Set the value of the DataTypeNodeProperties.NodeVersion Property, if it exists.

Parameters:

nodeVersion - the value to set.

Returns:

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

See Also:

• DataTypeNodeProperties

writeEnumStringsAsync

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

Set the value of the EnumStrings Property, if it exists.

Parameters:

enumStrings - the value to set.

Returns:

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

See Also:

• DataTypeNodeProperties

writeEnumValuesAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeEnumValuesAsync(org.eclipse.milo.opcua.stack.core.types.structured.EnumValueType[] enumValues)

Set the value of the DataTypeNodeProperties.EnumValues Property, if it exists.

Parameters:

enumValues - the value to set.

Returns:

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

See Also:

• DataTypeNodeProperties

writeOptionSetValuesAsync

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

Set the value of the DataTypeNodeProperties.OptionSetValues Property, if it exists.

Parameters:

optionSetValues - the value to set.

Returns:

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

See Also:

• DataTypeNodeProperties

getAttributeValue

protected org.eclipse.milo.opcua.stack.core.types.builtin.DataValue getAttributeValue(org.eclipse.milo.opcua.stack.core.AttributeId attributeId)

Overrides:

getAttributeValue in class UaNode

setAttributeValue

protected void setAttributeValue(org.eclipse.milo.opcua.stack.core.AttributeId attributeId,
 org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value)

Overrides:

setAttributeValue in class UaNode