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

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

Class PublishedDataSetTypeNode

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

All Implemented Interfaces:

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

Direct Known Subclasses:

PublishedDataItemsTypeNode, PublishedEventsTypeNode

public class PublishedDataSetTypeNode
extends BaseObjectTypeNode
implements PublishedDataSetType

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

CONFIGURATION_VERSION, CYCLIC_DATA_SET, DATA_SET_CLASS_ID, DATA_SET_META_DATA

Constructor Summary

Constructors

Constructor

Description

PublishedDataSetTypeNode(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.ConfigurationVersionDataType	getConfigurationVersion()	Get the local value of the ConfigurationVersion Node.
PropertyTypeNode	getConfigurationVersionNode()	Get the ConfigurationVersion PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getConfigurationVersionNodeAsync()	Asynchronous implementation of PublishedDataSetType.getConfigurationVersionNode().
Boolean	getCyclicDataSet()	Get the local value of the CyclicDataSet Node.
PropertyTypeNode	getCyclicDataSetNode()	Get the CyclicDataSet PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getCyclicDataSetNodeAsync()	Asynchronous implementation of PublishedDataSetType.getCyclicDataSetNode().
UUID	getDataSetClassId()	Get the local value of the DataSetClassId Node.
PropertyTypeNode	getDataSetClassIdNode()	Get the DataSetClassId PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getDataSetClassIdNodeAsync()	Asynchronous implementation of PublishedDataSetType.getDataSetClassIdNode().
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 PublishedDataSetType.getDataSetMetaDataNode().
ExtensionFieldsTypeNode	getExtensionFieldsNode()	Get the ExtensionFields ExtensionFieldsType Node, or null if it does not exist.
CompletableFuture<? extends ExtensionFieldsTypeNode>	getExtensionFieldsNodeAsync()	Asynchronous implementation of PublishedDataSetType.getExtensionFieldsNode().
org.eclipse.milo.opcua.stack.core.types.structured.ConfigurationVersionDataType	readConfigurationVersion()	Read the value of the ConfigurationVersion Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.ConfigurationVersionDataType>	readConfigurationVersionAsync()	An asynchronous implementation of PublishedDataSetType.readConfigurationVersion().
Boolean	readCyclicDataSet()	Read the value of the CyclicDataSet Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Boolean>	readCyclicDataSetAsync()	An asynchronous implementation of PublishedDataSetType.readCyclicDataSet().
UUID	readDataSetClassId()	Read the value of the DataSetClassId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends UUID>	readDataSetClassIdAsync()	An asynchronous implementation of PublishedDataSetType.readDataSetClassId().
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 PublishedDataSetType.readDataSetMetaData().
void	setConfigurationVersion(org.eclipse.milo.opcua.stack.core.types.structured.ConfigurationVersionDataType value)	Set the local value of the ConfigurationVersion Node.
void	setCyclicDataSet(Boolean value)	Set the local value of the CyclicDataSet Node.
void	setDataSetClassId(UUID value)	Set the local value of the DataSetClassId Node.
void	setDataSetMetaData(org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType value)	Set the local value of the DataSetMetaData Node.
void	writeConfigurationVersion(org.eclipse.milo.opcua.stack.core.types.structured.ConfigurationVersionDataType value)	Write a new value for the ConfigurationVersion Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeConfigurationVersionAsync(org.eclipse.milo.opcua.stack.core.types.structured.ConfigurationVersionDataType configurationVersion)	An asynchronous implementation of PublishedDataSetType.writeConfigurationVersion(org.eclipse.milo.opcua.stack.core.types.structured.ConfigurationVersionDataType).
void	writeCyclicDataSet(Boolean value)	Write a new value for the CyclicDataSet Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeCyclicDataSetAsync(Boolean cyclicDataSet)	An asynchronous implementation of PublishedDataSetType.writeCyclicDataSet(java.lang.Boolean).
void	writeDataSetClassId(UUID value)	Write a new value for the DataSetClassId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDataSetClassIdAsync(UUID dataSetClassId)	An asynchronous implementation of PublishedDataSetType.writeDataSetClassId(java.util.UUID).
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 PublishedDataSetType.writeDataSetMetaData(org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType).

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

PublishedDataSetTypeNode

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

getConfigurationVersion

public org.eclipse.milo.opcua.stack.core.types.structured.ConfigurationVersionDataType getConfigurationVersion()
                                                                                                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PublishedDataSetType

Get the local value of the ConfigurationVersion Node.

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

Specified by:

getConfigurationVersion in interface PublishedDataSetType

Returns:

the local value of the ConfigurationVersion Node.

Throws:

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

setConfigurationVersion

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

Description copied from interface: PublishedDataSetType

Set the local value of the ConfigurationVersion Node.

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

Specified by:

setConfigurationVersion in interface PublishedDataSetType

Parameters:

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

Throws:

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

readConfigurationVersion

public org.eclipse.milo.opcua.stack.core.types.structured.ConfigurationVersionDataType readConfigurationVersion()
                                                                                                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PublishedDataSetType

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

Specified by:

readConfigurationVersion in interface PublishedDataSetType

Returns:

the ConfigurationVersionDataType value read from the server.

Throws:

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

writeConfigurationVersion

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

Description copied from interface: PublishedDataSetType

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

Specified by:

writeConfigurationVersion in interface PublishedDataSetType

Parameters:

value - the ConfigurationVersionDataType value to write to the server.

Throws:

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

readConfigurationVersionAsync

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

Description copied from interface: PublishedDataSetType

An asynchronous implementation of PublishedDataSetType.readConfigurationVersion().

Specified by:

readConfigurationVersionAsync in interface PublishedDataSetType

Returns:

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

writeConfigurationVersionAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeConfigurationVersionAsync(org.eclipse.milo.opcua.stack.core.types.structured.ConfigurationVersionDataType configurationVersion)

Description copied from interface: PublishedDataSetType

An asynchronous implementation of PublishedDataSetType.writeConfigurationVersion(org.eclipse.milo.opcua.stack.core.types.structured.ConfigurationVersionDataType).

Specified by:

writeConfigurationVersionAsync in interface PublishedDataSetType

Returns:

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

getConfigurationVersionNode

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

Description copied from interface: PublishedDataSetType

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

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

Specified by:

getConfigurationVersionNode in interface PublishedDataSetType

Returns:

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

getConfigurationVersionNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getConfigurationVersionNodeAsync()

Description copied from interface: PublishedDataSetType

Asynchronous implementation of PublishedDataSetType.getConfigurationVersionNode().

Specified by:

getConfigurationVersionNodeAsync in interface PublishedDataSetType

Returns:

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

getDataSetMetaData

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

Description copied from interface: PublishedDataSetType

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 PublishedDataSetType

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: PublishedDataSetType

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 PublishedDataSetType

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: PublishedDataSetType

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

Specified by:

readDataSetMetaData in interface PublishedDataSetType

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: PublishedDataSetType

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 PublishedDataSetType

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: PublishedDataSetType

An asynchronous implementation of PublishedDataSetType.readDataSetMetaData().

Specified by:

readDataSetMetaDataAsync in interface PublishedDataSetType

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: PublishedDataSetType

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

Specified by:

writeDataSetMetaDataAsync in interface PublishedDataSetType

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: PublishedDataSetType

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 PublishedDataSetType

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: PublishedDataSetType

Asynchronous implementation of PublishedDataSetType.getDataSetMetaDataNode().

Specified by:

getDataSetMetaDataNodeAsync in interface PublishedDataSetType

Returns:

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

getDataSetClassId

public UUID getDataSetClassId()
                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PublishedDataSetType

Get the local value of the DataSetClassId Node.

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

Specified by:

getDataSetClassId in interface PublishedDataSetType

Returns:

the local value of the DataSetClassId Node.

Throws:

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

setDataSetClassId

public void setDataSetClassId(UUID value)
                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PublishedDataSetType

Set the local value of the DataSetClassId Node.

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

Specified by:

setDataSetClassId in interface PublishedDataSetType

Parameters:

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

Throws:

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

readDataSetClassId

public UUID readDataSetClassId()
                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PublishedDataSetType

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

Specified by:

readDataSetClassId in interface PublishedDataSetType

Returns:

the UUID value read from the server.

Throws:

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

writeDataSetClassId

public void writeDataSetClassId(UUID value)
                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PublishedDataSetType

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

Specified by:

writeDataSetClassId in interface PublishedDataSetType

Parameters:

value - the UUID value to write to the server.

Throws:

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

readDataSetClassIdAsync

public CompletableFuture<? extends UUID> readDataSetClassIdAsync()

Description copied from interface: PublishedDataSetType

An asynchronous implementation of PublishedDataSetType.readDataSetClassId().

Specified by:

readDataSetClassIdAsync in interface PublishedDataSetType

Returns:

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

writeDataSetClassIdAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeDataSetClassIdAsync(UUID dataSetClassId)

Description copied from interface: PublishedDataSetType

An asynchronous implementation of PublishedDataSetType.writeDataSetClassId(java.util.UUID).

Specified by:

writeDataSetClassIdAsync in interface PublishedDataSetType

Returns:

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

getDataSetClassIdNode

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

Description copied from interface: PublishedDataSetType

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

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

Specified by:

getDataSetClassIdNode in interface PublishedDataSetType

Returns:

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

getDataSetClassIdNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getDataSetClassIdNodeAsync()

Description copied from interface: PublishedDataSetType

Asynchronous implementation of PublishedDataSetType.getDataSetClassIdNode().

Specified by:

getDataSetClassIdNodeAsync in interface PublishedDataSetType

Returns:

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

getCyclicDataSet

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

Description copied from interface: PublishedDataSetType

Get the local value of the CyclicDataSet Node.

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

Specified by:

getCyclicDataSet in interface PublishedDataSetType

Returns:

the local value of the CyclicDataSet Node.

Throws:

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

setCyclicDataSet

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

Description copied from interface: PublishedDataSetType

Set the local value of the CyclicDataSet Node.

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

Specified by:

setCyclicDataSet in interface PublishedDataSetType

Parameters:

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

Throws:

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

readCyclicDataSet

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

Description copied from interface: PublishedDataSetType

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

Specified by:

readCyclicDataSet in interface PublishedDataSetType

Returns:

the Boolean value read from the server.

Throws:

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

writeCyclicDataSet

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

Description copied from interface: PublishedDataSetType

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

Specified by:

writeCyclicDataSet in interface PublishedDataSetType

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.

readCyclicDataSetAsync

public CompletableFuture<? extends Boolean> readCyclicDataSetAsync()

Description copied from interface: PublishedDataSetType

An asynchronous implementation of PublishedDataSetType.readCyclicDataSet().

Specified by:

readCyclicDataSetAsync in interface PublishedDataSetType

Returns:

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

writeCyclicDataSetAsync

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

Description copied from interface: PublishedDataSetType

An asynchronous implementation of PublishedDataSetType.writeCyclicDataSet(java.lang.Boolean).

Specified by:

writeCyclicDataSetAsync in interface PublishedDataSetType

Returns:

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

getCyclicDataSetNode

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

Description copied from interface: PublishedDataSetType

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

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

Specified by:

getCyclicDataSetNode in interface PublishedDataSetType

Returns:

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

getCyclicDataSetNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getCyclicDataSetNodeAsync()

Description copied from interface: PublishedDataSetType

Asynchronous implementation of PublishedDataSetType.getCyclicDataSetNode().

Specified by:

getCyclicDataSetNodeAsync in interface PublishedDataSetType

Returns:

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

getExtensionFieldsNode

public ExtensionFieldsTypeNode getExtensionFieldsNode()
                                               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: PublishedDataSetType

Get the ExtensionFields ExtensionFieldsType Node, or null if it does not exist.

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

Specified by:

getExtensionFieldsNode in interface PublishedDataSetType

Returns:

the ExtensionFields ExtensionFieldsType 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.

getExtensionFieldsNodeAsync

public CompletableFuture<? extends ExtensionFieldsTypeNode> getExtensionFieldsNodeAsync()

Description copied from interface: PublishedDataSetType

Asynchronous implementation of PublishedDataSetType.getExtensionFieldsNode().

Specified by:

getExtensionFieldsNodeAsync in interface PublishedDataSetType

Returns:

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