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

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

Class TargetVariablesTypeNode

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

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

All Implemented Interfaces:

BaseObjectType, SubscribedDataSetType, TargetVariablesType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

public class TargetVariablesTypeNode
extends SubscribedDataSetTypeNode
implements TargetVariablesType

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

TARGET_VARIABLES

Constructor Summary

Constructors

Constructor

Description

TargetVariablesTypeNode(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.structured.FieldTargetDataType[]	getTargetVariables()	Get the local value of the TargetVariables Node.
PropertyTypeNode	getTargetVariablesNode()	Get the TargetVariables PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getTargetVariablesNodeAsync()	Asynchronous implementation of TargetVariablesType.getTargetVariablesNode().
org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[]	readTargetVariables()	Read the value of the TargetVariables Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[]>	readTargetVariablesAsync()	An asynchronous implementation of TargetVariablesType.readTargetVariables().
void	setTargetVariables(org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[] value)	Set the local value of the TargetVariables Node.
void	writeTargetVariables(org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[] value)	Write a new value for the TargetVariables Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeTargetVariablesAsync(org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[] targetVariables)	An asynchronous implementation of TargetVariablesType.writeTargetVariables(org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[]).

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

TargetVariablesTypeNode

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

getTargetVariables

public org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[] getTargetVariables()
                                                                                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TargetVariablesType

Get the local value of the TargetVariables Node.

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

Specified by:

getTargetVariables in interface TargetVariablesType

Returns:

the local value of the TargetVariables Node.

Throws:

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

setTargetVariables

public void setTargetVariables(org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[] value)
                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TargetVariablesType

Set the local value of the TargetVariables Node.

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

Specified by:

setTargetVariables in interface TargetVariablesType

Parameters:

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

Throws:

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

readTargetVariables

public org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[] readTargetVariables()
                                                                                             throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TargetVariablesType

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

Specified by:

readTargetVariables in interface TargetVariablesType

Returns:

the FieldTargetDataType value read from the server.

Throws:

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

writeTargetVariables

public void writeTargetVariables(org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[] value)
                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TargetVariablesType

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

Specified by:

writeTargetVariables in interface TargetVariablesType

Parameters:

value - the FieldTargetDataType value to write to the server.

Throws:

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

readTargetVariablesAsync

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

Description copied from interface: TargetVariablesType

An asynchronous implementation of TargetVariablesType.readTargetVariables().

Specified by:

readTargetVariablesAsync in interface TargetVariablesType

Returns:

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

writeTargetVariablesAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeTargetVariablesAsync(org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[] targetVariables)

Description copied from interface: TargetVariablesType

An asynchronous implementation of TargetVariablesType.writeTargetVariables(org.eclipse.milo.opcua.stack.core.types.structured.FieldTargetDataType[]).

Specified by:

writeTargetVariablesAsync in interface TargetVariablesType

Returns:

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

getTargetVariablesNode

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

Description copied from interface: TargetVariablesType

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

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

Specified by:

getTargetVariablesNode in interface TargetVariablesType

Returns:

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

getTargetVariablesNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getTargetVariablesNodeAsync()

Description copied from interface: TargetVariablesType

Asynchronous implementation of TargetVariablesType.getTargetVariablesNode().

Specified by:

getTargetVariablesNodeAsync in interface TargetVariablesType

Returns:

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