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

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

Class IOrderedObjectTypeNode

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

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

All Implemented Interfaces:

BaseInterfaceType, BaseObjectType, IOrderedObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

public class IOrderedObjectTypeNode
extends BaseInterfaceTypeNode
implements IOrderedObjectType

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

NUMBER_IN_LIST

Constructor Summary

Constructors

Constructor

Description

IOrderedObjectTypeNode(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.Variant	getNumberInList()	Get the local value of the NumberInList Node.
PropertyTypeNode	getNumberInListNode()	Get the NumberInList PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getNumberInListNodeAsync()	Asynchronous implementation of IOrderedObjectType.getNumberInListNode().
org.eclipse.milo.opcua.stack.core.types.builtin.Variant	readNumberInList()	Read the value of the NumberInList Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.Variant>	readNumberInListAsync()	An asynchronous implementation of IOrderedObjectType.readNumberInList().
void	setNumberInList(org.eclipse.milo.opcua.stack.core.types.builtin.Variant value)	Set the local value of the NumberInList Node.
void	writeNumberInList(org.eclipse.milo.opcua.stack.core.types.builtin.Variant value)	Write a new value for the NumberInList Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeNumberInListAsync(org.eclipse.milo.opcua.stack.core.types.builtin.Variant numberInList)	An asynchronous implementation of IOrderedObjectType.writeNumberInList(org.eclipse.milo.opcua.stack.core.types.builtin.Variant).

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

IOrderedObjectTypeNode

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

getNumberInList

public org.eclipse.milo.opcua.stack.core.types.builtin.Variant getNumberInList()
                                                                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: IOrderedObjectType

Get the local value of the NumberInList Node.

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

Specified by:

getNumberInList in interface IOrderedObjectType

Returns:

the local value of the NumberInList Node.

Throws:

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

setNumberInList

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

Description copied from interface: IOrderedObjectType

Set the local value of the NumberInList Node.

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

Specified by:

setNumberInList in interface IOrderedObjectType

Parameters:

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

Throws:

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

readNumberInList

public org.eclipse.milo.opcua.stack.core.types.builtin.Variant readNumberInList()
                                                                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: IOrderedObjectType

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

Specified by:

readNumberInList in interface IOrderedObjectType

Returns:

the Variant value read from the server.

Throws:

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

writeNumberInList

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

Description copied from interface: IOrderedObjectType

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

Specified by:

writeNumberInList in interface IOrderedObjectType

Parameters:

value - the Variant value to write to the server.

Throws:

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

readNumberInListAsync

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

Description copied from interface: IOrderedObjectType

An asynchronous implementation of IOrderedObjectType.readNumberInList().

Specified by:

readNumberInListAsync in interface IOrderedObjectType

Returns:

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

writeNumberInListAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeNumberInListAsync(org.eclipse.milo.opcua.stack.core.types.builtin.Variant numberInList)

Description copied from interface: IOrderedObjectType

An asynchronous implementation of IOrderedObjectType.writeNumberInList(org.eclipse.milo.opcua.stack.core.types.builtin.Variant).

Specified by:

writeNumberInListAsync in interface IOrderedObjectType

Returns:

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

getNumberInListNode

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

Description copied from interface: IOrderedObjectType

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

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

Specified by:

getNumberInListNode in interface IOrderedObjectType

Returns:

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

getNumberInListNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getNumberInListNodeAsync()

Description copied from interface: IOrderedObjectType

Asynchronous implementation of IOrderedObjectType.getNumberInListNode().

Specified by:

getNumberInListNodeAsync in interface IOrderedObjectType

Returns:

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