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

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

Class TemporaryFileTransferTypeNode

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

All Implemented Interfaces:

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

public class TemporaryFileTransferTypeNode
extends BaseObjectTypeNode
implements TemporaryFileTransferType

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

CLIENT_PROCESSING_TIMEOUT

Constructor Summary

Constructors

Constructor

Description

TemporaryFileTransferTypeNode(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
Double	getClientProcessingTimeout()	Get the local value of the ClientProcessingTimeout Node.
PropertyTypeNode	getClientProcessingTimeoutNode()	Get the ClientProcessingTimeout PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getClientProcessingTimeoutNodeAsync()	Asynchronous implementation of TemporaryFileTransferType.getClientProcessingTimeoutNode().
Double	readClientProcessingTimeout()	Read the value of the ClientProcessingTimeout Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Double>	readClientProcessingTimeoutAsync()	An asynchronous implementation of TemporaryFileTransferType.readClientProcessingTimeout().
void	setClientProcessingTimeout(Double value)	Set the local value of the ClientProcessingTimeout Node.
void	writeClientProcessingTimeout(Double value)	Write a new value for the ClientProcessingTimeout Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeClientProcessingTimeoutAsync(Double clientProcessingTimeout)	An asynchronous implementation of TemporaryFileTransferType.writeClientProcessingTimeout(java.lang.Double).

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

TemporaryFileTransferTypeNode

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

getClientProcessingTimeout

public Double getClientProcessingTimeout()
                                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TemporaryFileTransferType

Get the local value of the ClientProcessingTimeout Node.

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

Specified by:

getClientProcessingTimeout in interface TemporaryFileTransferType

Returns:

the local value of the ClientProcessingTimeout Node.

Throws:

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

setClientProcessingTimeout

public void setClientProcessingTimeout(Double value)
                                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TemporaryFileTransferType

Set the local value of the ClientProcessingTimeout Node.

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

Specified by:

setClientProcessingTimeout in interface TemporaryFileTransferType

Parameters:

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

Throws:

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

readClientProcessingTimeout

public Double readClientProcessingTimeout()
                                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TemporaryFileTransferType

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

Specified by:

readClientProcessingTimeout in interface TemporaryFileTransferType

Returns:

the Double value read from the server.

Throws:

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

writeClientProcessingTimeout

public void writeClientProcessingTimeout(Double value)
                                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: TemporaryFileTransferType

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

Specified by:

writeClientProcessingTimeout in interface TemporaryFileTransferType

Parameters:

value - the Double value to write to the server.

Throws:

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

readClientProcessingTimeoutAsync

public CompletableFuture<? extends Double> readClientProcessingTimeoutAsync()

Description copied from interface: TemporaryFileTransferType

An asynchronous implementation of TemporaryFileTransferType.readClientProcessingTimeout().

Specified by:

readClientProcessingTimeoutAsync in interface TemporaryFileTransferType

Returns:

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

writeClientProcessingTimeoutAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeClientProcessingTimeoutAsync(Double clientProcessingTimeout)

Description copied from interface: TemporaryFileTransferType

An asynchronous implementation of TemporaryFileTransferType.writeClientProcessingTimeout(java.lang.Double).

Specified by:

writeClientProcessingTimeoutAsync in interface TemporaryFileTransferType

Returns:

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

getClientProcessingTimeoutNode

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

Description copied from interface: TemporaryFileTransferType

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

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

Specified by:

getClientProcessingTimeoutNode in interface TemporaryFileTransferType

Returns:

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

getClientProcessingTimeoutNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getClientProcessingTimeoutNodeAsync()

Description copied from interface: TemporaryFileTransferType

Asynchronous implementation of TemporaryFileTransferType.getClientProcessingTimeoutNode().

Specified by:

getClientProcessingTimeoutNodeAsync in interface TemporaryFileTransferType

Returns:

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