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

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

Class PublishedDataItemsTypeNode

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

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

All Implemented Interfaces:

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

public class PublishedDataItemsTypeNode
extends PublishedDataSetTypeNode
implements PublishedDataItemsType

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

PUBLISHED_DATA

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.objects.PublishedDataSetType

CONFIGURATION_VERSION, CYCLIC_DATA_SET, DATA_SET_CLASS_ID, DATA_SET_META_DATA

Constructor Summary

Constructors

Constructor

Description

PublishedDataItemsTypeNode(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.PublishedVariableDataType[]	getPublishedData()	Get the local value of the PublishedData Node.
PropertyTypeNode	getPublishedDataNode()	Get the PublishedData PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getPublishedDataNodeAsync()	Asynchronous implementation of PublishedDataItemsType.getPublishedDataNode().
org.eclipse.milo.opcua.stack.core.types.structured.PublishedVariableDataType[]	readPublishedData()	Read the value of the PublishedData Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.PublishedVariableDataType[]>	readPublishedDataAsync()	An asynchronous implementation of PublishedDataItemsType.readPublishedData().
void	setPublishedData(org.eclipse.milo.opcua.stack.core.types.structured.PublishedVariableDataType[] value)	Set the local value of the PublishedData Node.
void	writePublishedData(org.eclipse.milo.opcua.stack.core.types.structured.PublishedVariableDataType[] value)	Write a new value for the PublishedData Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writePublishedDataAsync(org.eclipse.milo.opcua.stack.core.types.structured.PublishedVariableDataType[] publishedData)	An asynchronous implementation of PublishedDataItemsType.writePublishedData(org.eclipse.milo.opcua.stack.core.types.structured.PublishedVariableDataType[]).

Methods inherited from class org.eclipse.milo.opcua.sdk.client.model.objects.PublishedDataSetTypeNode

getConfigurationVersion, getConfigurationVersionNode, getConfigurationVersionNodeAsync, getCyclicDataSet, getCyclicDataSetNode, getCyclicDataSetNodeAsync, getDataSetClassId, getDataSetClassIdNode, getDataSetClassIdNodeAsync, getDataSetMetaData, getDataSetMetaDataNode, getDataSetMetaDataNodeAsync, getExtensionFieldsNode, getExtensionFieldsNodeAsync, readConfigurationVersion, readConfigurationVersionAsync, readCyclicDataSet, readCyclicDataSetAsync, readDataSetClassId, readDataSetClassIdAsync, readDataSetMetaData, readDataSetMetaDataAsync, setConfigurationVersion, setCyclicDataSet, setDataSetClassId, setDataSetMetaData, writeConfigurationVersion, writeConfigurationVersionAsync, writeCyclicDataSet, writeCyclicDataSetAsync, writeDataSetClassId, writeDataSetClassIdAsync, writeDataSetMetaData, writeDataSetMetaDataAsync

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

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.objects.PublishedDataSetType

getConfigurationVersion, getConfigurationVersionNode, getConfigurationVersionNodeAsync, getCyclicDataSet, getCyclicDataSetNode, getCyclicDataSetNodeAsync, getDataSetClassId, getDataSetClassIdNode, getDataSetClassIdNodeAsync, getDataSetMetaData, getDataSetMetaDataNode, getDataSetMetaDataNodeAsync, getExtensionFieldsNode, getExtensionFieldsNodeAsync, readConfigurationVersion, readConfigurationVersionAsync, readCyclicDataSet, readCyclicDataSetAsync, readDataSetClassId, readDataSetClassIdAsync, readDataSetMetaData, readDataSetMetaDataAsync, setConfigurationVersion, setCyclicDataSet, setDataSetClassId, setDataSetMetaData, writeConfigurationVersion, writeConfigurationVersionAsync, writeCyclicDataSet, writeCyclicDataSetAsync, writeDataSetClassId, writeDataSetClassIdAsync, writeDataSetMetaData, writeDataSetMetaDataAsync

Constructor Details

PublishedDataItemsTypeNode

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

getPublishedData

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

Description copied from interface: PublishedDataItemsType

Get the local value of the PublishedData Node.

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

Specified by:

getPublishedData in interface PublishedDataItemsType

Returns:

the local value of the PublishedData Node.

Throws:

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

setPublishedData

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

Description copied from interface: PublishedDataItemsType

Set the local value of the PublishedData Node.

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

Specified by:

setPublishedData in interface PublishedDataItemsType

Parameters:

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

Throws:

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

readPublishedData

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

Description copied from interface: PublishedDataItemsType

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

Specified by:

readPublishedData in interface PublishedDataItemsType

Returns:

the PublishedVariableDataType value read from the server.

Throws:

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

writePublishedData

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

Description copied from interface: PublishedDataItemsType

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

Specified by:

writePublishedData in interface PublishedDataItemsType

Parameters:

value - the PublishedVariableDataType value to write to the server.

Throws:

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

readPublishedDataAsync

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

Description copied from interface: PublishedDataItemsType

An asynchronous implementation of PublishedDataItemsType.readPublishedData().

Specified by:

readPublishedDataAsync in interface PublishedDataItemsType

Returns:

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

writePublishedDataAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writePublishedDataAsync(org.eclipse.milo.opcua.stack.core.types.structured.PublishedVariableDataType[] publishedData)

Description copied from interface: PublishedDataItemsType

An asynchronous implementation of PublishedDataItemsType.writePublishedData(org.eclipse.milo.opcua.stack.core.types.structured.PublishedVariableDataType[]).

Specified by:

writePublishedDataAsync in interface PublishedDataItemsType

Returns:

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

getPublishedDataNode

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

Description copied from interface: PublishedDataItemsType

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

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

Specified by:

getPublishedDataNode in interface PublishedDataItemsType

Returns:

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

getPublishedDataNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getPublishedDataNodeAsync()

Description copied from interface: PublishedDataItemsType

Asynchronous implementation of PublishedDataItemsType.getPublishedDataNode().

Specified by:

getPublishedDataNodeAsync in interface PublishedDataItemsType

Returns:

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