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

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

Class ProvisionableDeviceTypeNode

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

All Implemented Interfaces:

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

public class ProvisionableDeviceTypeNode
extends BaseObjectTypeNode
implements ProvisionableDeviceType

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

IS_SINGLETON

Constructor Summary

Constructors

Constructor

Description

ProvisionableDeviceTypeNode(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
Boolean	getIsSingleton()	Get the local value of the IsSingleton Node.
PropertyTypeNode	getIsSingletonNode()	Get the IsSingleton PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getIsSingletonNodeAsync()	Asynchronous implementation of ProvisionableDeviceType.getIsSingletonNode().
Boolean	readIsSingleton()	Read the value of the IsSingleton Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readIsSingletonAsync()	An asynchronous implementation of ProvisionableDeviceType.readIsSingleton().
void	setIsSingleton(Boolean value)	Set the local value of the IsSingleton Node.
void	writeIsSingleton(Boolean value)	Write a new value for the IsSingleton Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeIsSingletonAsync(Boolean isSingleton)	An asynchronous implementation of ProvisionableDeviceType.writeIsSingleton(java.lang.Boolean).

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

ProvisionableDeviceTypeNode

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

getIsSingleton

public Boolean getIsSingleton()
                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ProvisionableDeviceType

Get the local value of the IsSingleton Node.

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

Specified by:

getIsSingleton in interface ProvisionableDeviceType

Returns:

the local value of the IsSingleton Node.

Throws:

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

setIsSingleton

public void setIsSingleton(Boolean value)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ProvisionableDeviceType

Set the local value of the IsSingleton Node.

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

Specified by:

setIsSingleton in interface ProvisionableDeviceType

Parameters:

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

Throws:

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

readIsSingleton

public Boolean readIsSingleton()
                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ProvisionableDeviceType

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

Specified by:

readIsSingleton in interface ProvisionableDeviceType

Returns:

the Boolean value read from the server.

Throws:

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

writeIsSingleton

public void writeIsSingleton(Boolean value)
                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ProvisionableDeviceType

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

Specified by:

writeIsSingleton in interface ProvisionableDeviceType

Parameters:

value - the Boolean value to write to the server.

Throws:

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

readIsSingletonAsync

public CompletableFuture<? extends Boolean> readIsSingletonAsync()

Description copied from interface: ProvisionableDeviceType

An asynchronous implementation of ProvisionableDeviceType.readIsSingleton().

Specified by:

readIsSingletonAsync in interface ProvisionableDeviceType

Returns:

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

writeIsSingletonAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeIsSingletonAsync(Boolean isSingleton)

Description copied from interface: ProvisionableDeviceType

An asynchronous implementation of ProvisionableDeviceType.writeIsSingleton(java.lang.Boolean).

Specified by:

writeIsSingletonAsync in interface ProvisionableDeviceType

Returns:

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

getIsSingletonNode

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

Description copied from interface: ProvisionableDeviceType

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

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

Specified by:

getIsSingletonNode in interface ProvisionableDeviceType

Returns:

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

getIsSingletonNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getIsSingletonNodeAsync()

Description copied from interface: ProvisionableDeviceType

Asynchronous implementation of ProvisionableDeviceType.getIsSingletonNode().

Specified by:

getIsSingletonNodeAsync in interface ProvisionableDeviceType

Returns:

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