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

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

Class StandaloneSubscribedDataSetTypeNode

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

All Implemented Interfaces:

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

public class StandaloneSubscribedDataSetTypeNode
extends BaseObjectTypeNode
implements StandaloneSubscribedDataSetType

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

DATA_SET_META_DATA, IS_CONNECTED

Constructor Summary

Constructors

Constructor

Description

StandaloneSubscribedDataSetTypeNode(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.DataSetMetaDataType	getDataSetMetaData()	Get the local value of the DataSetMetaData Node.
PropertyTypeNode	getDataSetMetaDataNode()	Get the DataSetMetaData PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getDataSetMetaDataNodeAsync()	Asynchronous implementation of StandaloneSubscribedDataSetType.getDataSetMetaDataNode().
Boolean	getIsConnected()	Get the local value of the IsConnected Node.
PropertyTypeNode	getIsConnectedNode()	Get the IsConnected PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getIsConnectedNodeAsync()	Asynchronous implementation of StandaloneSubscribedDataSetType.getIsConnectedNode().
SubscribedDataSetTypeNode	getSubscribedDataSetNode()	Get the SubscribedDataSet SubscribedDataSetType Node, or null if it does not exist.
CompletableFuture<? extends SubscribedDataSetTypeNode>	getSubscribedDataSetNodeAsync()	Asynchronous implementation of StandaloneSubscribedDataSetType.getSubscribedDataSetNode().
org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType	readDataSetMetaData()	Read the value of the DataSetMetaData Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType>	readDataSetMetaDataAsync()	An asynchronous implementation of StandaloneSubscribedDataSetType.readDataSetMetaData().
Boolean	readIsConnected()	Read the value of the IsConnected Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readIsConnectedAsync()	An asynchronous implementation of StandaloneSubscribedDataSetType.readIsConnected().
void	setDataSetMetaData(org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType value)	Set the local value of the DataSetMetaData Node.
void	setIsConnected(Boolean value)	Set the local value of the IsConnected Node.
void	writeDataSetMetaData(org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType value)	Write a new value for the DataSetMetaData Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDataSetMetaDataAsync(org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType dataSetMetaData)	An asynchronous implementation of StandaloneSubscribedDataSetType.writeDataSetMetaData(org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType).
void	writeIsConnected(Boolean value)	Write a new value for the IsConnected Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeIsConnectedAsync(Boolean isConnected)	An asynchronous implementation of StandaloneSubscribedDataSetType.writeIsConnected(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

StandaloneSubscribedDataSetTypeNode

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

getDataSetMetaData

public org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType getDataSetMetaData()
                                                                                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: StandaloneSubscribedDataSetType

Get the local value of the DataSetMetaData Node.

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

Specified by:

getDataSetMetaData in interface StandaloneSubscribedDataSetType

Returns:

the local value of the DataSetMetaData Node.

Throws:

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

setDataSetMetaData

public void setDataSetMetaData(org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType value)
                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: StandaloneSubscribedDataSetType

Set the local value of the DataSetMetaData Node.

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

Specified by:

setDataSetMetaData in interface StandaloneSubscribedDataSetType

Parameters:

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

Throws:

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

readDataSetMetaData

public org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType readDataSetMetaData()
                                                                                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: StandaloneSubscribedDataSetType

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

Specified by:

readDataSetMetaData in interface StandaloneSubscribedDataSetType

Returns:

the DataSetMetaDataType value read from the server.

Throws:

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

writeDataSetMetaData

public void writeDataSetMetaData(org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType value)
                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: StandaloneSubscribedDataSetType

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

Specified by:

writeDataSetMetaData in interface StandaloneSubscribedDataSetType

Parameters:

value - the DataSetMetaDataType value to write to the server.

Throws:

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

readDataSetMetaDataAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType> readDataSetMetaDataAsync()

Description copied from interface: StandaloneSubscribedDataSetType

An asynchronous implementation of StandaloneSubscribedDataSetType.readDataSetMetaData().

Specified by:

readDataSetMetaDataAsync in interface StandaloneSubscribedDataSetType

Returns:

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

writeDataSetMetaDataAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeDataSetMetaDataAsync(org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType dataSetMetaData)

Description copied from interface: StandaloneSubscribedDataSetType

An asynchronous implementation of StandaloneSubscribedDataSetType.writeDataSetMetaData(org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType).

Specified by:

writeDataSetMetaDataAsync in interface StandaloneSubscribedDataSetType

Returns:

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

getDataSetMetaDataNode

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

Description copied from interface: StandaloneSubscribedDataSetType

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

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

Specified by:

getDataSetMetaDataNode in interface StandaloneSubscribedDataSetType

Returns:

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

getDataSetMetaDataNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getDataSetMetaDataNodeAsync()

Description copied from interface: StandaloneSubscribedDataSetType

Asynchronous implementation of StandaloneSubscribedDataSetType.getDataSetMetaDataNode().

Specified by:

getDataSetMetaDataNodeAsync in interface StandaloneSubscribedDataSetType

Returns:

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

getIsConnected

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

Description copied from interface: StandaloneSubscribedDataSetType

Get the local value of the IsConnected Node.

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

Specified by:

getIsConnected in interface StandaloneSubscribedDataSetType

Returns:

the local value of the IsConnected Node.

Throws:

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

setIsConnected

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

Description copied from interface: StandaloneSubscribedDataSetType

Set the local value of the IsConnected Node.

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

Specified by:

setIsConnected in interface StandaloneSubscribedDataSetType

Parameters:

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

Throws:

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

readIsConnected

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

Description copied from interface: StandaloneSubscribedDataSetType

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

Specified by:

readIsConnected in interface StandaloneSubscribedDataSetType

Returns:

the Boolean value read from the server.

Throws:

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

writeIsConnected

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

Description copied from interface: StandaloneSubscribedDataSetType

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

Specified by:

writeIsConnected in interface StandaloneSubscribedDataSetType

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.

readIsConnectedAsync

public CompletableFuture<? extends Boolean> readIsConnectedAsync()

Description copied from interface: StandaloneSubscribedDataSetType

An asynchronous implementation of StandaloneSubscribedDataSetType.readIsConnected().

Specified by:

readIsConnectedAsync in interface StandaloneSubscribedDataSetType

Returns:

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

writeIsConnectedAsync

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

Description copied from interface: StandaloneSubscribedDataSetType

An asynchronous implementation of StandaloneSubscribedDataSetType.writeIsConnected(java.lang.Boolean).

Specified by:

writeIsConnectedAsync in interface StandaloneSubscribedDataSetType

Returns:

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

getIsConnectedNode

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

Description copied from interface: StandaloneSubscribedDataSetType

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

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

Specified by:

getIsConnectedNode in interface StandaloneSubscribedDataSetType

Returns:

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

getIsConnectedNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getIsConnectedNodeAsync()

Description copied from interface: StandaloneSubscribedDataSetType

Asynchronous implementation of StandaloneSubscribedDataSetType.getIsConnectedNode().

Specified by:

getIsConnectedNodeAsync in interface StandaloneSubscribedDataSetType

Returns:

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

getSubscribedDataSetNode

public SubscribedDataSetTypeNode getSubscribedDataSetNode()
                                                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: StandaloneSubscribedDataSetType

Get the SubscribedDataSet SubscribedDataSetType Node, or null if it does not exist.

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

Specified by:

getSubscribedDataSetNode in interface StandaloneSubscribedDataSetType

Returns:

the SubscribedDataSet SubscribedDataSetType 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.

getSubscribedDataSetNodeAsync

public CompletableFuture<? extends SubscribedDataSetTypeNode> getSubscribedDataSetNodeAsync()

Description copied from interface: StandaloneSubscribedDataSetType

Asynchronous implementation of StandaloneSubscribedDataSetType.getSubscribedDataSetNode().

Specified by:

getSubscribedDataSetNodeAsync in interface StandaloneSubscribedDataSetType

Returns:

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