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

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

Class DatagramDataSetReaderTransportTypeNode

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

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

All Implemented Interfaces:

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

public class DatagramDataSetReaderTransportTypeNode
extends DataSetReaderTransportTypeNode
implements DatagramDataSetReaderTransportType

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

DATAGRAM_QOS, QOS_CATEGORY, TOPIC

Constructor Summary

Constructors

Constructor

Description

DatagramDataSetReaderTransportTypeNode(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
NetworkAddressTypeNode	getAddressNode()	Get the Address NetworkAddressType Node, or null if it does not exist.
CompletableFuture<? extends NetworkAddressTypeNode>	getAddressNodeAsync()	Asynchronous implementation of DatagramDataSetReaderTransportType.getAddressNode().
org.eclipse.milo.opcua.stack.core.types.structured.ReceiveQosDataType[]	getDatagramQos()	Get the local value of the DatagramQos Node.
PropertyTypeNode	getDatagramQosNode()	Get the DatagramQos PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getDatagramQosNodeAsync()	Asynchronous implementation of DatagramDataSetReaderTransportType.getDatagramQosNode().
String	getQosCategory()	Get the local value of the QosCategory Node.
PropertyTypeNode	getQosCategoryNode()	Get the QosCategory PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getQosCategoryNodeAsync()	Asynchronous implementation of DatagramDataSetReaderTransportType.getQosCategoryNode().
String	getTopic()	Get the local value of the Topic Node.
PropertyTypeNode	getTopicNode()	Get the Topic PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getTopicNodeAsync()	Asynchronous implementation of DatagramDataSetReaderTransportType.getTopicNode().
org.eclipse.milo.opcua.stack.core.types.structured.ReceiveQosDataType[]	readDatagramQos()	Read the value of the DatagramQos Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.ReceiveQosDataType[]>	readDatagramQosAsync()	An asynchronous implementation of DatagramDataSetReaderTransportType.readDatagramQos().
String	readQosCategory()	Read the value of the QosCategory Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readQosCategoryAsync()	An asynchronous implementation of DatagramDataSetReaderTransportType.readQosCategory().
String	readTopic()	Read the value of the Topic Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readTopicAsync()	An asynchronous implementation of DatagramDataSetReaderTransportType.readTopic().
void	setDatagramQos(org.eclipse.milo.opcua.stack.core.types.structured.ReceiveQosDataType[] value)	Set the local value of the DatagramQos Node.
void	setQosCategory(String value)	Set the local value of the QosCategory Node.
void	setTopic(String value)	Set the local value of the Topic Node.
void	writeDatagramQos(org.eclipse.milo.opcua.stack.core.types.structured.ReceiveQosDataType[] value)	Write a new value for the DatagramQos Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDatagramQosAsync(org.eclipse.milo.opcua.stack.core.types.structured.ReceiveQosDataType[] datagramQos)	An asynchronous implementation of DatagramDataSetReaderTransportType.writeDatagramQos(org.eclipse.milo.opcua.stack.core.types.structured.ReceiveQosDataType[]).
void	writeQosCategory(String value)	Write a new value for the QosCategory Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeQosCategoryAsync(String qosCategory)	An asynchronous implementation of DatagramDataSetReaderTransportType.writeQosCategory(java.lang.String).
void	writeTopic(String value)	Write a new value for the Topic Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeTopicAsync(String topic)	An asynchronous implementation of DatagramDataSetReaderTransportType.writeTopic(java.lang.String).

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

DatagramDataSetReaderTransportTypeNode

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

getQosCategory

public String getQosCategory()
                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DatagramDataSetReaderTransportType

Get the local value of the QosCategory Node.

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

Specified by:

getQosCategory in interface DatagramDataSetReaderTransportType

Returns:

the local value of the QosCategory Node.

Throws:

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

setQosCategory

public void setQosCategory(String value)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DatagramDataSetReaderTransportType

Set the local value of the QosCategory Node.

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

Specified by:

setQosCategory in interface DatagramDataSetReaderTransportType

Parameters:

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

Throws:

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

readQosCategory

public String readQosCategory()
                       throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DatagramDataSetReaderTransportType

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

Specified by:

readQosCategory in interface DatagramDataSetReaderTransportType

Returns:

the String value read from the server.

Throws:

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

writeQosCategory

public void writeQosCategory(String value)
                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DatagramDataSetReaderTransportType

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

Specified by:

writeQosCategory in interface DatagramDataSetReaderTransportType

Parameters:

value - the String value to write to the server.

Throws:

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

readQosCategoryAsync

public CompletableFuture<? extends String> readQosCategoryAsync()

Description copied from interface: DatagramDataSetReaderTransportType

An asynchronous implementation of DatagramDataSetReaderTransportType.readQosCategory().

Specified by:

readQosCategoryAsync in interface DatagramDataSetReaderTransportType

Returns:

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

writeQosCategoryAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeQosCategoryAsync(String qosCategory)

Description copied from interface: DatagramDataSetReaderTransportType

An asynchronous implementation of DatagramDataSetReaderTransportType.writeQosCategory(java.lang.String).

Specified by:

writeQosCategoryAsync in interface DatagramDataSetReaderTransportType

Returns:

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

getQosCategoryNode

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

Description copied from interface: DatagramDataSetReaderTransportType

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

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

Specified by:

getQosCategoryNode in interface DatagramDataSetReaderTransportType

Returns:

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

getQosCategoryNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getQosCategoryNodeAsync()

Description copied from interface: DatagramDataSetReaderTransportType

Asynchronous implementation of DatagramDataSetReaderTransportType.getQosCategoryNode().

Specified by:

getQosCategoryNodeAsync in interface DatagramDataSetReaderTransportType

Returns:

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

getDatagramQos

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

Description copied from interface: DatagramDataSetReaderTransportType

Get the local value of the DatagramQos Node.

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

Specified by:

getDatagramQos in interface DatagramDataSetReaderTransportType

Returns:

the local value of the DatagramQos Node.

Throws:

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

setDatagramQos

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

Description copied from interface: DatagramDataSetReaderTransportType

Set the local value of the DatagramQos Node.

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

Specified by:

setDatagramQos in interface DatagramDataSetReaderTransportType

Parameters:

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

Throws:

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

readDatagramQos

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

Description copied from interface: DatagramDataSetReaderTransportType

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

Specified by:

readDatagramQos in interface DatagramDataSetReaderTransportType

Returns:

the ReceiveQosDataType value read from the server.

Throws:

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

writeDatagramQos

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

Description copied from interface: DatagramDataSetReaderTransportType

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

Specified by:

writeDatagramQos in interface DatagramDataSetReaderTransportType

Parameters:

value - the ReceiveQosDataType value to write to the server.

Throws:

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

readDatagramQosAsync

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

Description copied from interface: DatagramDataSetReaderTransportType

An asynchronous implementation of DatagramDataSetReaderTransportType.readDatagramQos().

Specified by:

readDatagramQosAsync in interface DatagramDataSetReaderTransportType

Returns:

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

writeDatagramQosAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeDatagramQosAsync(org.eclipse.milo.opcua.stack.core.types.structured.ReceiveQosDataType[] datagramQos)

Description copied from interface: DatagramDataSetReaderTransportType

An asynchronous implementation of DatagramDataSetReaderTransportType.writeDatagramQos(org.eclipse.milo.opcua.stack.core.types.structured.ReceiveQosDataType[]).

Specified by:

writeDatagramQosAsync in interface DatagramDataSetReaderTransportType

Returns:

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

getDatagramQosNode

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

Description copied from interface: DatagramDataSetReaderTransportType

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

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

Specified by:

getDatagramQosNode in interface DatagramDataSetReaderTransportType

Returns:

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

getDatagramQosNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getDatagramQosNodeAsync()

Description copied from interface: DatagramDataSetReaderTransportType

Asynchronous implementation of DatagramDataSetReaderTransportType.getDatagramQosNode().

Specified by:

getDatagramQosNodeAsync in interface DatagramDataSetReaderTransportType

Returns:

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

getTopic

public String getTopic()
                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DatagramDataSetReaderTransportType

Get the local value of the Topic Node.

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

Specified by:

getTopic in interface DatagramDataSetReaderTransportType

Returns:

the local value of the Topic Node.

Throws:

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

setTopic

public void setTopic(String value)
              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DatagramDataSetReaderTransportType

Set the local value of the Topic Node.

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

Specified by:

setTopic in interface DatagramDataSetReaderTransportType

Parameters:

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

Throws:

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

readTopic

public String readTopic()
                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DatagramDataSetReaderTransportType

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

Specified by:

readTopic in interface DatagramDataSetReaderTransportType

Returns:

the String value read from the server.

Throws:

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

writeTopic

public void writeTopic(String value)
                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DatagramDataSetReaderTransportType

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

Specified by:

writeTopic in interface DatagramDataSetReaderTransportType

Parameters:

value - the String value to write to the server.

Throws:

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

readTopicAsync

public CompletableFuture<? extends String> readTopicAsync()

Description copied from interface: DatagramDataSetReaderTransportType

An asynchronous implementation of DatagramDataSetReaderTransportType.readTopic().

Specified by:

readTopicAsync in interface DatagramDataSetReaderTransportType

Returns:

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

writeTopicAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeTopicAsync(String topic)

Description copied from interface: DatagramDataSetReaderTransportType

An asynchronous implementation of DatagramDataSetReaderTransportType.writeTopic(java.lang.String).

Specified by:

writeTopicAsync in interface DatagramDataSetReaderTransportType

Returns:

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

getTopicNode

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

Description copied from interface: DatagramDataSetReaderTransportType

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

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

Specified by:

getTopicNode in interface DatagramDataSetReaderTransportType

Returns:

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

getTopicNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getTopicNodeAsync()

Description copied from interface: DatagramDataSetReaderTransportType

Asynchronous implementation of DatagramDataSetReaderTransportType.getTopicNode().

Specified by:

getTopicNodeAsync in interface DatagramDataSetReaderTransportType

Returns:

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

getAddressNode

public NetworkAddressTypeNode getAddressNode()
                                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: DatagramDataSetReaderTransportType

Get the Address NetworkAddressType Node, or null if it does not exist.

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

Specified by:

getAddressNode in interface DatagramDataSetReaderTransportType

Returns:

the Address NetworkAddressType 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.

getAddressNodeAsync

public CompletableFuture<? extends NetworkAddressTypeNode> getAddressNodeAsync()

Description copied from interface: DatagramDataSetReaderTransportType

Asynchronous implementation of DatagramDataSetReaderTransportType.getAddressNode().

Specified by:

getAddressNodeAsync in interface DatagramDataSetReaderTransportType

Returns:

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