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

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

Class UaReferenceTypeNode

java.lang.Object

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

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

All Implemented Interfaces:

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

public class UaReferenceTypeNode
extends UaNode
implements org.eclipse.milo.opcua.sdk.core.nodes.ReferenceTypeNode

Field Summary

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

client

Constructor Summary

Constructors

Constructor	Description
UaReferenceTypeNode(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, Boolean symmetric, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText inverseName)	Construct a UaReferenceTypeNode using only attributes defined prior to OPC UA 1.04.
UaReferenceTypeNode(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, Boolean symmetric, org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText inverseName)	Construct a UaReferenceTypeNode 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)
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getInverseName()
Boolean	getIsAbstract()
Boolean	getSymmetric()
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readInverseName()	Read the InverseName attribute for this Node from the server and update the local attribute if the operation succeeds.
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 ReferenceTypeNodeProperties.NodeVersion Property, if it exists.
Boolean	readSymmetric()	Read the Symmetric attribute for this Node from the server and update the local attribute if the operation succeeds.
protected void	setAttributeValue(org.eclipse.milo.opcua.stack.core.AttributeId attributeId, org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value)
void	setInverseName(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText inverseName)
void	setIsAbstract(Boolean isAbstract)
void	setSymmetric(Boolean symmetric)
void	writeInverseName(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText inverseName)	Write a new InverseName attribute for this Node to the server and update the local attribute if the operation succeeds.
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 ReferenceTypeNodeProperties.NodeVersion Property, if it exists.
void	writeSymmetric(Boolean symmetric)	Write a new Symmetric attribute for this Node to the server and update the local attribute if the operation succeeds.

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

UaReferenceTypeNode

public UaReferenceTypeNode(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,
 Boolean symmetric,
 org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText inverseName)

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

UaReferenceTypeNode

public UaReferenceTypeNode(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,
 Boolean symmetric,
 org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText inverseName)

Construct a UaReferenceTypeNode 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.ReferenceTypeNode

See Also:

• readIsAbstract()

getSymmetric

public Boolean getSymmetric()

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

Specified by:

getSymmetric in interface org.eclipse.milo.opcua.sdk.core.nodes.ReferenceTypeNode

See Also:

• readSymmetric()

getInverseName

public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getInverseName()

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

Specified by:

getInverseName in interface org.eclipse.milo.opcua.sdk.core.nodes.ReferenceTypeNode

See Also:

• readInverseName()

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

See Also:

• writeIsAbstract(Boolean)

setSymmetric

public void setSymmetric(Boolean symmetric)

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

Specified by:

setSymmetric in interface org.eclipse.milo.opcua.sdk.core.nodes.ReferenceTypeNode

See Also:

• writeSymmetric(Boolean)

setInverseName

public void setInverseName(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText inverseName)

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

Specified by:

setInverseName in interface org.eclipse.milo.opcua.sdk.core.nodes.ReferenceTypeNode

See Also:

• writeInverseName(LocalizedText)

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

readSymmetric

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

Read the Symmetric 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

readInverseName

public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readInverseName()
                                                                              throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

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

writeSymmetric

public void writeSymmetric(Boolean symmetric)
                    throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

symmetric - the Boolean to write to the server.

Throws:

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

writeInverseName

public void writeInverseName(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText inverseName)
                      throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

inverseName - the LocalizedText 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 ReferenceTypeNodeProperties.NodeVersion Property, if it exists.

Returns:

the value of the NodeVersion Property, if it exists.

See Also:

• ReferenceTypeNodeProperties

writeNodeVersionAsync

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

Set the value of the ReferenceTypeNodeProperties.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:

• ReferenceTypeNodeProperties

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