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

Package org.eclipse.milo.opcua.sdk.client.nodes

Class UaViewNode

java.lang.Object

org.eclipse.milo.opcua.sdk.client.nodes.UaNode

org.eclipse.milo.opcua.sdk.client.nodes.UaViewNode

All Implemented Interfaces:

org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ViewNode

public class UaViewNode
extends UaNode
implements org.eclipse.milo.opcua.sdk.core.nodes.ViewNode

Field Summary

Fields inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaNode

client

Constructor Summary

Constructors

Constructor	Description
UaViewNode(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, Boolean containsNoLoops, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier)	Construct a UaViewNode using only attributes defined prior to OPC UA 1.04.
UaViewNode(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, Boolean containsNoLoops, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier)	Construct a UaViewNode using all attributes, including those defined by OPC UA 1.04.

Method Summary

Modifier and Type	Method	Description
protected org.eclipse.milo.opcua.stack.core.types.builtin.DataValue	getAttributeValue(org.eclipse.milo.opcua.stack.core.AttributeId attributeId)
Boolean	getContainsNoLoops()
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte	getEventNotifier()
Boolean	readContainsNoLoops()	Read the ContainsNoLoops attribute for this Node from the server and update the local attribute if the operation succeeds.
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte	readEventNotifier()	Read the EventNotifier attribute for this Node from the server and update the local attribute if the operation succeeds.
CompletableFuture<? extends String>	readNodeVersionAsync()	Get the value of the ViewNodeProperties.NodeVersion Property, if it exists.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	readViewVersionAsync()	Get the value of the ViewNodeProperties.ViewVersion Property, if it exists.
protected void	setAttributeValue(org.eclipse.milo.opcua.stack.core.AttributeId attributeId, org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value)
void	setContainsNoLoops(Boolean containsNoLoops)
void	setEventNotifier(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier)
void	writeContainsNoLoops(Boolean containsNoLoops)	Write a new ContainsNoLoops attribute for this Node to the server and update the local attribute if the operation succeeds.
void	writeEventNotifier(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier)	Write a new EventNotifier attribute for this Node to the server and update the local attribute if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeNodeVersionAsync(String nodeVersion)	Set the value of the ViewNodeProperties.NodeVersion Property, if it exists.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeViewVersionAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger viewVersion)	Set the value of the ViewNodeProperties.ViewVersion Property, if it exists.

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

Constructor Details

UaViewNode

public UaViewNode(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,
 Boolean containsNoLoops,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier)

Construct a UaViewNode using only attributes defined prior to OPC UA 1.04.

UaViewNode

public UaViewNode(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,
 Boolean containsNoLoops,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier)

Construct a UaViewNode using all attributes, including those defined by OPC UA 1.04.

Method Details

getContainsNoLoops

public Boolean getContainsNoLoops()

The returned attribute is the most recently seen value; it is not read live from the server.

Specified by:

getContainsNoLoops in interface org.eclipse.milo.opcua.sdk.core.nodes.ViewNode

See Also:

• readContainsNoLoops()

getEventNotifier

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte getEventNotifier()

The returned attribute is the most recently seen value; it is not read live from the server.

Specified by:

getEventNotifier in interface org.eclipse.milo.opcua.sdk.core.nodes.ViewNode

See Also:

• readEventNotifier()

setContainsNoLoops

public void setContainsNoLoops(Boolean containsNoLoops)

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

Specified by:

setContainsNoLoops in interface org.eclipse.milo.opcua.sdk.core.nodes.ViewNode

See Also:

• writeContainsNoLoops(Boolean)

setEventNotifier

public void setEventNotifier(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier)

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

Specified by:

setEventNotifier in interface org.eclipse.milo.opcua.sdk.core.nodes.ViewNode

See Also:

• writeEventNotifier(UByte)

readContainsNoLoops

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

Read the ContainsNoLoops attribute for this Node from the server and update the local attribute if the operation succeeds.

Returns:

the Boolean read from the server.

Throws:

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

readEventNotifier

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte readEventNotifier()
                                                                                 throws org.eclipse.milo.opcua.stack.core.UaException

Read the EventNotifier attribute for this Node from the server and update the local attribute if the operation succeeds.

Returns:

the UByte read from the server.

Throws:

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

writeContainsNoLoops

public void writeContainsNoLoops(Boolean containsNoLoops)
                          throws org.eclipse.milo.opcua.stack.core.UaException

Write a new ContainsNoLoops attribute for this Node to the server and update the local attribute if the operation succeeds.

Parameters:

containsNoLoops - the Boolean to write to the server.

Throws:

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

writeEventNotifier

public void writeEventNotifier(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte eventNotifier)
                        throws org.eclipse.milo.opcua.stack.core.UaException

Write a new EventNotifier attribute for this Node to the server and update the local attribute if the operation succeeds.

Parameters:

eventNotifier - the UByte to write to the server.

Throws:

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

readNodeVersionAsync

public CompletableFuture<? extends String> readNodeVersionAsync()

Get the value of the ViewNodeProperties.NodeVersion Property, if it exists.

Returns:

the value of the NodeVersion Property, if it exists.

See Also:

• ViewNodeProperties

readViewVersionAsync

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

Get the value of the ViewNodeProperties.ViewVersion Property, if it exists.

Returns:

the value of the ViewVersion Property, if it exists.

See Also:

• ViewNodeProperties

writeNodeVersionAsync

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

Set the value of the ViewNodeProperties.NodeVersion Property, if it exists.

Parameters:

nodeVersion - the value to set.

Returns:

a CompletableFuture that completes with the StatusCode of the write operation.

See Also:

• ViewNodeProperties

writeViewVersionAsync

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

Set the value of the ViewNodeProperties.ViewVersion Property, if it exists.

Parameters:

viewVersion - the value to set.

Returns:

a CompletableFuture that completes with the StatusCode of the write operation.

See Also:

• ViewNodeProperties

getAttributeValue

protected org.eclipse.milo.opcua.stack.core.types.builtin.DataValue getAttributeValue(org.eclipse.milo.opcua.stack.core.AttributeId attributeId)

Overrides:

getAttributeValue in class UaNode

setAttributeValue

protected void setAttributeValue(org.eclipse.milo.opcua.stack.core.AttributeId attributeId,
 org.eclipse.milo.opcua.stack.core.types.builtin.DataValue value)

Overrides:

setAttributeValue in class UaNode