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

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

Class DataSetWriterTypeNode

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

All Implemented Interfaces:

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

public class DataSetWriterTypeNode
extends BaseObjectTypeNode
implements DataSetWriterType

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

DATA_SET_FIELD_CONTENT_MASK, DATA_SET_WRITER_ID, DATA_SET_WRITER_PROPERTIES, KEY_FRAME_COUNT

Constructor Summary

Constructors

Constructor

Description

DataSetWriterTypeNode(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.DataSetFieldContentMask	getDataSetFieldContentMask()	Get the local value of the DataSetFieldContentMask Node.
PropertyTypeNode	getDataSetFieldContentMaskNode()	Get the DataSetFieldContentMask PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getDataSetFieldContentMaskNodeAsync()	Asynchronous implementation of DataSetWriterType.getDataSetFieldContentMaskNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort	getDataSetWriterId()	Get the local value of the DataSetWriterId Node.
PropertyTypeNode	getDataSetWriterIdNode()	Get the DataSetWriterId PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getDataSetWriterIdNodeAsync()	Asynchronous implementation of DataSetWriterType.getDataSetWriterIdNode().
org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]	getDataSetWriterProperties()	Get the local value of the DataSetWriterProperties Node.
PropertyTypeNode	getDataSetWriterPropertiesNode()	Get the DataSetWriterProperties PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getDataSetWriterPropertiesNodeAsync()	Asynchronous implementation of DataSetWriterType.getDataSetWriterPropertiesNode().
PubSubDiagnosticsDataSetWriterTypeNode	getDiagnosticsNode()	Get the Diagnostics PubSubDiagnosticsDataSetWriterType Node, or null if it does not exist.
CompletableFuture<? extends PubSubDiagnosticsDataSetWriterTypeNode>	getDiagnosticsNodeAsync()	Asynchronous implementation of DataSetWriterType.getDiagnosticsNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getKeyFrameCount()	Get the local value of the KeyFrameCount Node.
PropertyTypeNode	getKeyFrameCountNode()	Get the KeyFrameCount PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getKeyFrameCountNodeAsync()	Asynchronous implementation of DataSetWriterType.getKeyFrameCountNode().
DataSetWriterMessageTypeNode	getMessageSettingsNode()	Get the MessageSettings DataSetWriterMessageType Node, or null if it does not exist.
CompletableFuture<? extends DataSetWriterMessageTypeNode>	getMessageSettingsNodeAsync()	Asynchronous implementation of DataSetWriterType.getMessageSettingsNode().
PubSubStatusTypeNode	getStatusNode()	Get the Status PubSubStatusType Node, or null if it does not exist.
CompletableFuture<? extends PubSubStatusTypeNode>	getStatusNodeAsync()	Asynchronous implementation of DataSetWriterType.getStatusNode().
DataSetWriterTransportTypeNode	getTransportSettingsNode()	Get the TransportSettings DataSetWriterTransportType Node, or null if it does not exist.
CompletableFuture<? extends DataSetWriterTransportTypeNode>	getTransportSettingsNodeAsync()	Asynchronous implementation of DataSetWriterType.getTransportSettingsNode().
org.eclipse.milo.opcua.stack.core.types.structured.DataSetFieldContentMask	readDataSetFieldContentMask()	Read the value of the DataSetFieldContentMask Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.DataSetFieldContentMask>	readDataSetFieldContentMaskAsync()	An asynchronous implementation of DataSetWriterType.readDataSetFieldContentMask().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort	readDataSetWriterId()	Read the value of the DataSetWriterId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort>	readDataSetWriterIdAsync()	An asynchronous implementation of DataSetWriterType.readDataSetWriterId().
org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]	readDataSetWriterProperties()	Read the value of the DataSetWriterProperties Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]>	readDataSetWriterPropertiesAsync()	An asynchronous implementation of DataSetWriterType.readDataSetWriterProperties().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	readKeyFrameCount()	Read the value of the KeyFrameCount Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	readKeyFrameCountAsync()	An asynchronous implementation of DataSetWriterType.readKeyFrameCount().
void	setDataSetFieldContentMask(org.eclipse.milo.opcua.stack.core.types.structured.DataSetFieldContentMask value)	Set the local value of the DataSetFieldContentMask Node.
void	setDataSetWriterId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)	Set the local value of the DataSetWriterId Node.
void	setDataSetWriterProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] value)	Set the local value of the DataSetWriterProperties Node.
void	setKeyFrameCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)	Set the local value of the KeyFrameCount Node.
void	writeDataSetFieldContentMask(org.eclipse.milo.opcua.stack.core.types.structured.DataSetFieldContentMask value)	Write a new value for the DataSetFieldContentMask Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDataSetFieldContentMaskAsync(org.eclipse.milo.opcua.stack.core.types.structured.DataSetFieldContentMask dataSetFieldContentMask)	An asynchronous implementation of DataSetWriterType.writeDataSetFieldContentMask(org.eclipse.milo.opcua.stack.core.types.structured.DataSetFieldContentMask).
void	writeDataSetWriterId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)	Write a new value for the DataSetWriterId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDataSetWriterIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort dataSetWriterId)	An asynchronous implementation of DataSetWriterType.writeDataSetWriterId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort).
void	writeDataSetWriterProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] value)	Write a new value for the DataSetWriterProperties Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDataSetWriterPropertiesAsync(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] dataSetWriterProperties)	An asynchronous implementation of DataSetWriterType.writeDataSetWriterProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]).
void	writeKeyFrameCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)	Write a new value for the KeyFrameCount Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeKeyFrameCountAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger keyFrameCount)	An asynchronous implementation of DataSetWriterType.writeKeyFrameCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).

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

DataSetWriterTypeNode

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

getDataSetWriterId

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort getDataSetWriterId()
                                                                                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataSetWriterType

Get the local value of the DataSetWriterId Node.

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

Specified by:

getDataSetWriterId in interface DataSetWriterType

Returns:

the local value of the DataSetWriterId Node.

Throws:

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

setDataSetWriterId

public void setDataSetWriterId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)
                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataSetWriterType

Set the local value of the DataSetWriterId Node.

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

Specified by:

setDataSetWriterId in interface DataSetWriterType

Parameters:

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

Throws:

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

readDataSetWriterId

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort readDataSetWriterId()
                                                                                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataSetWriterType

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

Specified by:

readDataSetWriterId in interface DataSetWriterType

Returns:

the UShort value read from the server.

Throws:

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

writeDataSetWriterId

public void writeDataSetWriterId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)
                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataSetWriterType

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

Specified by:

writeDataSetWriterId in interface DataSetWriterType

Parameters:

value - the UShort value to write to the server.

Throws:

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

readDataSetWriterIdAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort> readDataSetWriterIdAsync()

Description copied from interface: DataSetWriterType

An asynchronous implementation of DataSetWriterType.readDataSetWriterId().

Specified by:

readDataSetWriterIdAsync in interface DataSetWriterType

Returns:

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

writeDataSetWriterIdAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeDataSetWriterIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort dataSetWriterId)

Description copied from interface: DataSetWriterType

An asynchronous implementation of DataSetWriterType.writeDataSetWriterId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort).

Specified by:

writeDataSetWriterIdAsync in interface DataSetWriterType

Returns:

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

getDataSetWriterIdNode

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

Description copied from interface: DataSetWriterType

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

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

Specified by:

getDataSetWriterIdNode in interface DataSetWriterType

Returns:

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

getDataSetWriterIdNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getDataSetWriterIdNodeAsync()

Description copied from interface: DataSetWriterType

Asynchronous implementation of DataSetWriterType.getDataSetWriterIdNode().

Specified by:

getDataSetWriterIdNodeAsync in interface DataSetWriterType

Returns:

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

getDataSetFieldContentMask

public org.eclipse.milo.opcua.stack.core.types.structured.DataSetFieldContentMask getDataSetFieldContentMask()
                                                                                                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataSetWriterType

Get the local value of the DataSetFieldContentMask Node.

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

Specified by:

getDataSetFieldContentMask in interface DataSetWriterType

Returns:

the local value of the DataSetFieldContentMask Node.

Throws:

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

setDataSetFieldContentMask

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

Description copied from interface: DataSetWriterType

Set the local value of the DataSetFieldContentMask Node.

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

Specified by:

setDataSetFieldContentMask in interface DataSetWriterType

Parameters:

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

Throws:

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

readDataSetFieldContentMask

public org.eclipse.milo.opcua.stack.core.types.structured.DataSetFieldContentMask readDataSetFieldContentMask()
                                                                                                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataSetWriterType

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

Specified by:

readDataSetFieldContentMask in interface DataSetWriterType

Returns:

the DataSetFieldContentMask value read from the server.

Throws:

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

writeDataSetFieldContentMask

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

Description copied from interface: DataSetWriterType

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

Specified by:

writeDataSetFieldContentMask in interface DataSetWriterType

Parameters:

value - the DataSetFieldContentMask value to write to the server.

Throws:

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

readDataSetFieldContentMaskAsync

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

Description copied from interface: DataSetWriterType

An asynchronous implementation of DataSetWriterType.readDataSetFieldContentMask().

Specified by:

readDataSetFieldContentMaskAsync in interface DataSetWriterType

Returns:

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

writeDataSetFieldContentMaskAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeDataSetFieldContentMaskAsync(org.eclipse.milo.opcua.stack.core.types.structured.DataSetFieldContentMask dataSetFieldContentMask)

Description copied from interface: DataSetWriterType

An asynchronous implementation of DataSetWriterType.writeDataSetFieldContentMask(org.eclipse.milo.opcua.stack.core.types.structured.DataSetFieldContentMask).

Specified by:

writeDataSetFieldContentMaskAsync in interface DataSetWriterType

Returns:

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

getDataSetFieldContentMaskNode

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

Description copied from interface: DataSetWriterType

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

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

Specified by:

getDataSetFieldContentMaskNode in interface DataSetWriterType

Returns:

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

getDataSetFieldContentMaskNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getDataSetFieldContentMaskNodeAsync()

Description copied from interface: DataSetWriterType

Asynchronous implementation of DataSetWriterType.getDataSetFieldContentMaskNode().

Specified by:

getDataSetFieldContentMaskNodeAsync in interface DataSetWriterType

Returns:

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

getKeyFrameCount

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getKeyFrameCount()
                                                                                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataSetWriterType

Get the local value of the KeyFrameCount Node.

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

Specified by:

getKeyFrameCount in interface DataSetWriterType

Returns:

the local value of the KeyFrameCount Node.

Throws:

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

setKeyFrameCount

public void setKeyFrameCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataSetWriterType

Set the local value of the KeyFrameCount Node.

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

Specified by:

setKeyFrameCount in interface DataSetWriterType

Parameters:

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

Throws:

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

readKeyFrameCount

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readKeyFrameCount()
                                                                                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataSetWriterType

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

Specified by:

readKeyFrameCount in interface DataSetWriterType

Returns:

the UInteger value read from the server.

Throws:

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

writeKeyFrameCount

public void writeKeyFrameCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataSetWriterType

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

Specified by:

writeKeyFrameCount in interface DataSetWriterType

Parameters:

value - the UInteger value to write to the server.

Throws:

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

readKeyFrameCountAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> readKeyFrameCountAsync()

Description copied from interface: DataSetWriterType

An asynchronous implementation of DataSetWriterType.readKeyFrameCount().

Specified by:

readKeyFrameCountAsync in interface DataSetWriterType

Returns:

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

writeKeyFrameCountAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeKeyFrameCountAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger keyFrameCount)

Description copied from interface: DataSetWriterType

An asynchronous implementation of DataSetWriterType.writeKeyFrameCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).

Specified by:

writeKeyFrameCountAsync in interface DataSetWriterType

Returns:

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

getKeyFrameCountNode

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

Description copied from interface: DataSetWriterType

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

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

Specified by:

getKeyFrameCountNode in interface DataSetWriterType

Returns:

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

getKeyFrameCountNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getKeyFrameCountNodeAsync()

Description copied from interface: DataSetWriterType

Asynchronous implementation of DataSetWriterType.getKeyFrameCountNode().

Specified by:

getKeyFrameCountNodeAsync in interface DataSetWriterType

Returns:

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

getDataSetWriterProperties

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

Description copied from interface: DataSetWriterType

Get the local value of the DataSetWriterProperties Node.

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

Specified by:

getDataSetWriterProperties in interface DataSetWriterType

Returns:

the local value of the DataSetWriterProperties Node.

Throws:

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

setDataSetWriterProperties

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

Description copied from interface: DataSetWriterType

Set the local value of the DataSetWriterProperties Node.

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

Specified by:

setDataSetWriterProperties in interface DataSetWriterType

Parameters:

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

Throws:

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

readDataSetWriterProperties

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

Description copied from interface: DataSetWriterType

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

Specified by:

readDataSetWriterProperties in interface DataSetWriterType

Returns:

the KeyValuePair value read from the server.

Throws:

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

writeDataSetWriterProperties

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

Description copied from interface: DataSetWriterType

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

Specified by:

writeDataSetWriterProperties in interface DataSetWriterType

Parameters:

value - the KeyValuePair value to write to the server.

Throws:

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

readDataSetWriterPropertiesAsync

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

Description copied from interface: DataSetWriterType

An asynchronous implementation of DataSetWriterType.readDataSetWriterProperties().

Specified by:

readDataSetWriterPropertiesAsync in interface DataSetWriterType

Returns:

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

writeDataSetWriterPropertiesAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeDataSetWriterPropertiesAsync(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] dataSetWriterProperties)

Description copied from interface: DataSetWriterType

An asynchronous implementation of DataSetWriterType.writeDataSetWriterProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]).

Specified by:

writeDataSetWriterPropertiesAsync in interface DataSetWriterType

Returns:

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

getDataSetWriterPropertiesNode

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

Description copied from interface: DataSetWriterType

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

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

Specified by:

getDataSetWriterPropertiesNode in interface DataSetWriterType

Returns:

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

getDataSetWriterPropertiesNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getDataSetWriterPropertiesNodeAsync()

Description copied from interface: DataSetWriterType

Asynchronous implementation of DataSetWriterType.getDataSetWriterPropertiesNode().

Specified by:

getDataSetWriterPropertiesNodeAsync in interface DataSetWriterType

Returns:

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

getTransportSettingsNode

public DataSetWriterTransportTypeNode getTransportSettingsNode()
                                                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataSetWriterType

Get the TransportSettings DataSetWriterTransportType Node, or null if it does not exist.

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

Specified by:

getTransportSettingsNode in interface DataSetWriterType

Returns:

the TransportSettings DataSetWriterTransportType 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.

getTransportSettingsNodeAsync

public CompletableFuture<? extends DataSetWriterTransportTypeNode> getTransportSettingsNodeAsync()

Description copied from interface: DataSetWriterType

Asynchronous implementation of DataSetWriterType.getTransportSettingsNode().

Specified by:

getTransportSettingsNodeAsync in interface DataSetWriterType

Returns:

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

getMessageSettingsNode

public DataSetWriterMessageTypeNode getMessageSettingsNode()
                                                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataSetWriterType

Get the MessageSettings DataSetWriterMessageType Node, or null if it does not exist.

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

Specified by:

getMessageSettingsNode in interface DataSetWriterType

Returns:

the MessageSettings DataSetWriterMessageType 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.

getMessageSettingsNodeAsync

public CompletableFuture<? extends DataSetWriterMessageTypeNode> getMessageSettingsNodeAsync()

Description copied from interface: DataSetWriterType

Asynchronous implementation of DataSetWriterType.getMessageSettingsNode().

Specified by:

getMessageSettingsNodeAsync in interface DataSetWriterType

Returns:

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

getStatusNode

public PubSubStatusTypeNode getStatusNode()
                                   throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataSetWriterType

Get the Status PubSubStatusType Node, or null if it does not exist.

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

Specified by:

getStatusNode in interface DataSetWriterType

Returns:

the Status PubSubStatusType 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.

getStatusNodeAsync

public CompletableFuture<? extends PubSubStatusTypeNode> getStatusNodeAsync()

Description copied from interface: DataSetWriterType

Asynchronous implementation of DataSetWriterType.getStatusNode().

Specified by:

getStatusNodeAsync in interface DataSetWriterType

Returns:

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

getDiagnosticsNode

public PubSubDiagnosticsDataSetWriterTypeNode getDiagnosticsNode()
                                                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DataSetWriterType

Get the Diagnostics PubSubDiagnosticsDataSetWriterType Node, or null if it does not exist.

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

Specified by:

getDiagnosticsNode in interface DataSetWriterType

Returns:

the Diagnostics PubSubDiagnosticsDataSetWriterType 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.

getDiagnosticsNodeAsync

public CompletableFuture<? extends PubSubDiagnosticsDataSetWriterTypeNode> getDiagnosticsNodeAsync()

Description copied from interface: DataSetWriterType

Asynchronous implementation of DataSetWriterType.getDiagnosticsNode().

Specified by:

getDiagnosticsNodeAsync in interface DataSetWriterType

Returns:

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