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

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

Class UnitTypeNode

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AlternativeUnitTypeNode, ServerUnitTypeNode

public class UnitTypeNode
extends BaseObjectTypeNode
implements UnitType

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

DISCIPLINE, SYMBOL, UNIT_SYSTEM

Constructor Summary

Constructors

Constructor

Description

UnitTypeNode(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
String	getDiscipline()	Get the local value of the Discipline Node.
PropertyTypeNode	getDisciplineNode()	Get the Discipline PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getDisciplineNodeAsync()	Asynchronous implementation of UnitType.getDisciplineNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getSymbol()	Get the local value of the Symbol Node.
PropertyTypeNode	getSymbolNode()	Get the Symbol PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getSymbolNodeAsync()	Asynchronous implementation of UnitType.getSymbolNode().
String	getUnitSystem()	Get the local value of the UnitSystem Node.
PropertyTypeNode	getUnitSystemNode()	Get the UnitSystem PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getUnitSystemNodeAsync()	Asynchronous implementation of UnitType.getUnitSystemNode().
String	readDiscipline()	Read the value of the Discipline Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readDisciplineAsync()	An asynchronous implementation of UnitType.readDiscipline().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readSymbol()	Read the value of the Symbol Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readSymbolAsync()	An asynchronous implementation of UnitType.readSymbol().
String	readUnitSystem()	Read the value of the UnitSystem Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readUnitSystemAsync()	An asynchronous implementation of UnitType.readUnitSystem().
void	setDiscipline(String value)	Set the local value of the Discipline Node.
void	setSymbol(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	Set the local value of the Symbol Node.
void	setUnitSystem(String value)	Set the local value of the UnitSystem Node.
void	writeDiscipline(String value)	Write a new value for the Discipline Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDisciplineAsync(String discipline)	An asynchronous implementation of UnitType.writeDiscipline(java.lang.String).
void	writeSymbol(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	Write a new value for the Symbol Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeSymbolAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText symbol)	An asynchronous implementation of UnitType.writeSymbol(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText).
void	writeUnitSystem(String value)	Write a new value for the UnitSystem Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeUnitSystemAsync(String unitSystem)	An asynchronous implementation of UnitType.writeUnitSystem(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

UnitTypeNode

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

getSymbol

public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getSymbol()
                                                                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: UnitType

Get the local value of the Symbol Node.

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

Specified by:

getSymbol in interface UnitType

Returns:

the local value of the Symbol Node.

Throws:

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

setSymbol

public void setSymbol(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)
               throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: UnitType

Set the local value of the Symbol Node.

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

Specified by:

setSymbol in interface UnitType

Parameters:

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

Throws:

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

readSymbol

public org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readSymbol()
                                                                         throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: UnitType

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

Specified by:

readSymbol in interface UnitType

Returns:

the LocalizedText value read from the server.

Throws:

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

writeSymbol

public void writeSymbol(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)
                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: UnitType

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

Specified by:

writeSymbol in interface UnitType

Parameters:

value - the LocalizedText value to write to the server.

Throws:

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

readSymbolAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText> readSymbolAsync()

Description copied from interface: UnitType

An asynchronous implementation of UnitType.readSymbol().

Specified by:

readSymbolAsync in interface UnitType

Returns:

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

writeSymbolAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSymbolAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText symbol)

Description copied from interface: UnitType

An asynchronous implementation of UnitType.writeSymbol(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText).

Specified by:

writeSymbolAsync in interface UnitType

Returns:

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

getSymbolNode

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

Description copied from interface: UnitType

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

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

Specified by:

getSymbolNode in interface UnitType

Returns:

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

getSymbolNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getSymbolNodeAsync()

Description copied from interface: UnitType

Asynchronous implementation of UnitType.getSymbolNode().

Specified by:

getSymbolNodeAsync in interface UnitType

Returns:

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

getUnitSystem

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

Description copied from interface: UnitType

Get the local value of the UnitSystem Node.

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

Specified by:

getUnitSystem in interface UnitType

Returns:

the local value of the UnitSystem Node.

Throws:

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

setUnitSystem

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

Description copied from interface: UnitType

Set the local value of the UnitSystem Node.

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

Specified by:

setUnitSystem in interface UnitType

Parameters:

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

Throws:

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

readUnitSystem

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

Description copied from interface: UnitType

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

Specified by:

readUnitSystem in interface UnitType

Returns:

the String value read from the server.

Throws:

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

writeUnitSystem

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

Description copied from interface: UnitType

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

Specified by:

writeUnitSystem in interface UnitType

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.

readUnitSystemAsync

public CompletableFuture<? extends String> readUnitSystemAsync()

Description copied from interface: UnitType

An asynchronous implementation of UnitType.readUnitSystem().

Specified by:

readUnitSystemAsync in interface UnitType

Returns:

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

writeUnitSystemAsync

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

Description copied from interface: UnitType

An asynchronous implementation of UnitType.writeUnitSystem(java.lang.String).

Specified by:

writeUnitSystemAsync in interface UnitType

Returns:

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

getUnitSystemNode

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

Description copied from interface: UnitType

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

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

Specified by:

getUnitSystemNode in interface UnitType

Returns:

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

getUnitSystemNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getUnitSystemNodeAsync()

Description copied from interface: UnitType

Asynchronous implementation of UnitType.getUnitSystemNode().

Specified by:

getUnitSystemNodeAsync in interface UnitType

Returns:

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

getDiscipline

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

Description copied from interface: UnitType

Get the local value of the Discipline Node.

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

Specified by:

getDiscipline in interface UnitType

Returns:

the local value of the Discipline Node.

Throws:

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

setDiscipline

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

Description copied from interface: UnitType

Set the local value of the Discipline Node.

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

Specified by:

setDiscipline in interface UnitType

Parameters:

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

Throws:

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

readDiscipline

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

Description copied from interface: UnitType

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

Specified by:

readDiscipline in interface UnitType

Returns:

the String value read from the server.

Throws:

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

writeDiscipline

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

Description copied from interface: UnitType

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

Specified by:

writeDiscipline in interface UnitType

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.

readDisciplineAsync

public CompletableFuture<? extends String> readDisciplineAsync()

Description copied from interface: UnitType

An asynchronous implementation of UnitType.readDiscipline().

Specified by:

readDisciplineAsync in interface UnitType

Returns:

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

writeDisciplineAsync

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

Description copied from interface: UnitType

An asynchronous implementation of UnitType.writeDiscipline(java.lang.String).

Specified by:

writeDisciplineAsync in interface UnitType

Returns:

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

getDisciplineNode

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

Description copied from interface: UnitType

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

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

Specified by:

getDisciplineNode in interface UnitType

Returns:

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

getDisciplineNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getDisciplineNodeAsync()

Description copied from interface: UnitType

Asynchronous implementation of UnitType.getDisciplineNode().

Specified by:

getDisciplineNodeAsync in interface UnitType

Returns:

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