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

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

Class JsonDataSetWriterMessageTypeNode

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

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

All Implemented Interfaces:

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

public class JsonDataSetWriterMessageTypeNode
extends DataSetWriterMessageTypeNode
implements JsonDataSetWriterMessageType

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

DATA_SET_MESSAGE_CONTENT_MASK

Constructor Summary

Constructors

Constructor

Description

JsonDataSetWriterMessageTypeNode(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.JsonDataSetMessageContentMask	getDataSetMessageContentMask()	Get the local value of the DataSetMessageContentMask Node.
PropertyTypeNode	getDataSetMessageContentMaskNode()	Get the DataSetMessageContentMask PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getDataSetMessageContentMaskNodeAsync()	Asynchronous implementation of JsonDataSetWriterMessageType.getDataSetMessageContentMaskNode().
org.eclipse.milo.opcua.stack.core.types.structured.JsonDataSetMessageContentMask	readDataSetMessageContentMask()	Read the value of the DataSetMessageContentMask Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.JsonDataSetMessageContentMask>	readDataSetMessageContentMaskAsync()	An asynchronous implementation of JsonDataSetWriterMessageType.readDataSetMessageContentMask().
void	setDataSetMessageContentMask(org.eclipse.milo.opcua.stack.core.types.structured.JsonDataSetMessageContentMask value)	Set the local value of the DataSetMessageContentMask Node.
void	writeDataSetMessageContentMask(org.eclipse.milo.opcua.stack.core.types.structured.JsonDataSetMessageContentMask value)	Write a new value for the DataSetMessageContentMask Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDataSetMessageContentMaskAsync(org.eclipse.milo.opcua.stack.core.types.structured.JsonDataSetMessageContentMask dataSetMessageContentMask)	An asynchronous implementation of JsonDataSetWriterMessageType.writeDataSetMessageContentMask(org.eclipse.milo.opcua.stack.core.types.structured.JsonDataSetMessageContentMask).

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

JsonDataSetWriterMessageTypeNode

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

getDataSetMessageContentMask

public org.eclipse.milo.opcua.stack.core.types.structured.JsonDataSetMessageContentMask getDataSetMessageContentMask()
                                                                                                              throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: JsonDataSetWriterMessageType

Get the local value of the DataSetMessageContentMask Node.

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

Specified by:

getDataSetMessageContentMask in interface JsonDataSetWriterMessageType

Returns:

the local value of the DataSetMessageContentMask Node.

Throws:

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

setDataSetMessageContentMask

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

Description copied from interface: JsonDataSetWriterMessageType

Set the local value of the DataSetMessageContentMask Node.

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

Specified by:

setDataSetMessageContentMask in interface JsonDataSetWriterMessageType

Parameters:

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

Throws:

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

readDataSetMessageContentMask

public org.eclipse.milo.opcua.stack.core.types.structured.JsonDataSetMessageContentMask readDataSetMessageContentMask()
                                                                                                               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: JsonDataSetWriterMessageType

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

Specified by:

readDataSetMessageContentMask in interface JsonDataSetWriterMessageType

Returns:

the JsonDataSetMessageContentMask value read from the server.

Throws:

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

writeDataSetMessageContentMask

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

Description copied from interface: JsonDataSetWriterMessageType

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

Specified by:

writeDataSetMessageContentMask in interface JsonDataSetWriterMessageType

Parameters:

value - the JsonDataSetMessageContentMask value to write to the server.

Throws:

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

readDataSetMessageContentMaskAsync

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

Description copied from interface: JsonDataSetWriterMessageType

An asynchronous implementation of JsonDataSetWriterMessageType.readDataSetMessageContentMask().

Specified by:

readDataSetMessageContentMaskAsync in interface JsonDataSetWriterMessageType

Returns:

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

writeDataSetMessageContentMaskAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeDataSetMessageContentMaskAsync(org.eclipse.milo.opcua.stack.core.types.structured.JsonDataSetMessageContentMask dataSetMessageContentMask)

Description copied from interface: JsonDataSetWriterMessageType

An asynchronous implementation of JsonDataSetWriterMessageType.writeDataSetMessageContentMask(org.eclipse.milo.opcua.stack.core.types.structured.JsonDataSetMessageContentMask).

Specified by:

writeDataSetMessageContentMaskAsync in interface JsonDataSetWriterMessageType

Returns:

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

getDataSetMessageContentMaskNode

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

Description copied from interface: JsonDataSetWriterMessageType

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

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

Specified by:

getDataSetMessageContentMaskNode in interface JsonDataSetWriterMessageType

Returns:

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

getDataSetMessageContentMaskNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getDataSetMessageContentMaskNodeAsync()

Description copied from interface: JsonDataSetWriterMessageType

Asynchronous implementation of JsonDataSetWriterMessageType.getDataSetMessageContentMaskNode().

Specified by:

getDataSetMessageContentMaskNodeAsync in interface JsonDataSetWriterMessageType

Returns:

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