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

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

Class SyntaxReferenceEntryTypeNode

java.lang.Object

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

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

org.eclipse.milo.opcua.sdk.client.model.objects.BaseObjectTypeNode

org.eclipse.milo.opcua.sdk.client.model.objects.DictionaryEntryTypeNode

org.eclipse.milo.opcua.sdk.client.model.objects.SyntaxReferenceEntryTypeNode

All Implemented Interfaces:

BaseObjectType, DictionaryEntryType, SyntaxReferenceEntryType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

public class SyntaxReferenceEntryTypeNode
extends DictionaryEntryTypeNode
implements SyntaxReferenceEntryType

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.objects.SyntaxReferenceEntryType

COMMON_NAME

Constructor Summary

Constructors

Constructor

Description

SyntaxReferenceEntryTypeNode(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.unsigned.UByte eventNotifier)

Method Summary

Modifier and Type	Method	Description
String	getCommonName()	Get the local value of the CommonName Node.
PropertyTypeNode	getCommonNameNode()	Get the CommonName PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getCommonNameNodeAsync()	Asynchronous implementation of SyntaxReferenceEntryType.getCommonNameNode().
String	readCommonName()	Read the value of the CommonName Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readCommonNameAsync()	An asynchronous implementation of SyntaxReferenceEntryType.readCommonName().
void	setCommonName(String value)	Set the local value of the CommonName Node.
void	writeCommonName(String value)	Write a new value for the CommonName Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeCommonNameAsync(String commonName)	An asynchronous implementation of SyntaxReferenceEntryType.writeCommonName(java.lang.String).

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaObjectNode

callMethod, callMethod, callMethodAsync, callMethodAsync, getAttributeValue, getEventNotifier, getIconAsync, getMethod, getMethod, getMethodAsync, getMethodAsync, getNamingRuleAsync, getNodeVersionAsync, getObjectComponent, getObjectComponent, getObjectComponent, getObjectComponentAsync, getObjectComponentAsync, getObjectComponentAsync, getTypeDefinition, getTypeDefinitionAsync, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readEventNotifier, setAttributeValue, setEventNotifier, setIconAsync, setNamingRuleAsync, setNodeVersionAsync, writeEventNotifier

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

getEventNotifier, setEventNotifier

Constructor Details

SyntaxReferenceEntryTypeNode

public SyntaxReferenceEntryTypeNode(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.unsigned.UByte eventNotifier)

Method Details

getCommonName

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

Description copied from interface: SyntaxReferenceEntryType

Get the local value of the CommonName Node.

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

Specified by:

getCommonName in interface SyntaxReferenceEntryType

Returns:

the local value of the CommonName Node.

Throws:

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

setCommonName

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

Description copied from interface: SyntaxReferenceEntryType

Set the local value of the CommonName Node.

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

Specified by:

setCommonName in interface SyntaxReferenceEntryType

Parameters:

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

Throws:

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

readCommonName

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

Description copied from interface: SyntaxReferenceEntryType

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

Specified by:

readCommonName in interface SyntaxReferenceEntryType

Returns:

the String value read from the server.

Throws:

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

writeCommonName

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

Description copied from interface: SyntaxReferenceEntryType

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

Specified by:

writeCommonName in interface SyntaxReferenceEntryType

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.

readCommonNameAsync

public CompletableFuture<? extends String> readCommonNameAsync()

Description copied from interface: SyntaxReferenceEntryType

An asynchronous implementation of SyntaxReferenceEntryType.readCommonName().

Specified by:

readCommonNameAsync in interface SyntaxReferenceEntryType

Returns:

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

writeCommonNameAsync

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

Description copied from interface: SyntaxReferenceEntryType

An asynchronous implementation of SyntaxReferenceEntryType.writeCommonName(java.lang.String).

Specified by:

writeCommonNameAsync in interface SyntaxReferenceEntryType

Returns:

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

getCommonNameNode

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

Description copied from interface: SyntaxReferenceEntryType

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

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

Specified by:

getCommonNameNode in interface SyntaxReferenceEntryType

Returns:

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

getCommonNameNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getCommonNameNodeAsync()

Description copied from interface: SyntaxReferenceEntryType

Asynchronous implementation of SyntaxReferenceEntryType.getCommonNameNode().

Specified by:

getCommonNameNodeAsync in interface SyntaxReferenceEntryType

Returns:

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