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

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

Class AliasNameCategoryTypeNode

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

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

All Implemented Interfaces:

AliasNameCategoryType, BaseObjectType, FolderType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

public class AliasNameCategoryTypeNode
extends FolderTypeNode
implements AliasNameCategoryType

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

LAST_CHANGE

Constructor Summary

Constructors

Constructor

Description

AliasNameCategoryTypeNode(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
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getLastChange()	Get the local value of the LastChange Node.
PropertyTypeNode	getLastChangeNode()	Get the LastChange PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getLastChangeNodeAsync()	Asynchronous implementation of AliasNameCategoryType.getLastChangeNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	readLastChange()	Read the value of the LastChange Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	readLastChangeAsync()	An asynchronous implementation of AliasNameCategoryType.readLastChange().
void	setLastChange(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)	Set the local value of the LastChange Node.
void	writeLastChange(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)	Write a new value for the LastChange Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeLastChangeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger lastChange)	An asynchronous implementation of AliasNameCategoryType.writeLastChange(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).

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

AliasNameCategoryTypeNode

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

getLastChange

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getLastChange()
                                                                                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AliasNameCategoryType

Get the local value of the LastChange Node.

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

Specified by:

getLastChange in interface AliasNameCategoryType

Returns:

the local value of the LastChange Node.

Throws:

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

setLastChange

public void setLastChange(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AliasNameCategoryType

Set the local value of the LastChange Node.

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

Specified by:

setLastChange in interface AliasNameCategoryType

Parameters:

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

Throws:

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

readLastChange

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readLastChange()
                                                                                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AliasNameCategoryType

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

Specified by:

readLastChange in interface AliasNameCategoryType

Returns:

the UInteger value read from the server.

Throws:

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

writeLastChange

public void writeLastChange(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AliasNameCategoryType

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

Specified by:

writeLastChange in interface AliasNameCategoryType

Parameters:

value - the UInteger value to write to the server.

Throws:

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

readLastChangeAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> readLastChangeAsync()

Description copied from interface: AliasNameCategoryType

An asynchronous implementation of AliasNameCategoryType.readLastChange().

Specified by:

readLastChangeAsync in interface AliasNameCategoryType

Returns:

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

writeLastChangeAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeLastChangeAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger lastChange)

Description copied from interface: AliasNameCategoryType

An asynchronous implementation of AliasNameCategoryType.writeLastChange(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).

Specified by:

writeLastChangeAsync in interface AliasNameCategoryType

Returns:

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

getLastChangeNode

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

Description copied from interface: AliasNameCategoryType

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

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

Specified by:

getLastChangeNode in interface AliasNameCategoryType

Returns:

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

getLastChangeNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getLastChangeNodeAsync()

Description copied from interface: AliasNameCategoryType

Asynchronous implementation of AliasNameCategoryType.getLastChangeNode().

Specified by:

getLastChangeNodeAsync in interface AliasNameCategoryType

Returns:

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