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

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

Class ServerUnitTypeNode

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

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

All Implemented Interfaces:

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

public class ServerUnitTypeNode
extends UnitTypeNode
implements ServerUnitType

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

CONVERSION_LIMIT

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.objects.UnitType

DISCIPLINE, SYMBOL, UNIT_SYSTEM

Constructor Summary

Constructors

Constructor

Description

ServerUnitTypeNode(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
BaseObjectTypeNode	getAlternativeUnitsNode()	Get the AlternativeUnits BaseObjectType Node, or null if it does not exist.
CompletableFuture<? extends BaseObjectTypeNode>	getAlternativeUnitsNodeAsync()	Asynchronous implementation of ServerUnitType.getAlternativeUnitsNode().
UnitTypeNode	getCoherentUnitNode()	Get the CoherentUnit UnitType Node, or null if it does not exist.
CompletableFuture<? extends UnitTypeNode>	getCoherentUnitNodeAsync()	Asynchronous implementation of ServerUnitType.getCoherentUnitNode().
org.eclipse.milo.opcua.stack.core.types.enumerated.ConversionLimitEnum	getConversionLimit()	Get the local value of the ConversionLimit Node.
PropertyTypeNode	getConversionLimitNode()	Get the ConversionLimit PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getConversionLimitNodeAsync()	Asynchronous implementation of ServerUnitType.getConversionLimitNode().
org.eclipse.milo.opcua.stack.core.types.enumerated.ConversionLimitEnum	readConversionLimit()	Read the value of the ConversionLimit Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.enumerated.ConversionLimitEnum>	readConversionLimitAsync()	An asynchronous implementation of ServerUnitType.readConversionLimit().
void	setConversionLimit(org.eclipse.milo.opcua.stack.core.types.enumerated.ConversionLimitEnum value)	Set the local value of the ConversionLimit Node.
void	writeConversionLimit(org.eclipse.milo.opcua.stack.core.types.enumerated.ConversionLimitEnum value)	Write a new value for the ConversionLimit Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeConversionLimitAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.ConversionLimitEnum conversionLimit)	An asynchronous implementation of ServerUnitType.writeConversionLimit(org.eclipse.milo.opcua.stack.core.types.enumerated.ConversionLimitEnum).

Methods inherited from class org.eclipse.milo.opcua.sdk.client.model.objects.UnitTypeNode

getDiscipline, getDisciplineNode, getDisciplineNodeAsync, getSymbol, getSymbolNode, getSymbolNodeAsync, getUnitSystem, getUnitSystemNode, getUnitSystemNodeAsync, readDiscipline, readDisciplineAsync, readSymbol, readSymbolAsync, readUnitSystem, readUnitSystemAsync, setDiscipline, setSymbol, setUnitSystem, writeDiscipline, writeDisciplineAsync, writeSymbol, writeSymbolAsync, writeUnitSystem, writeUnitSystemAsync

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

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.objects.UnitType

getDiscipline, getDisciplineNode, getDisciplineNodeAsync, getSymbol, getSymbolNode, getSymbolNodeAsync, getUnitSystem, getUnitSystemNode, getUnitSystemNodeAsync, readDiscipline, readDisciplineAsync, readSymbol, readSymbolAsync, readUnitSystem, readUnitSystemAsync, setDiscipline, setSymbol, setUnitSystem, writeDiscipline, writeDisciplineAsync, writeSymbol, writeSymbolAsync, writeUnitSystem, writeUnitSystemAsync

Constructor Details

ServerUnitTypeNode

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

getConversionLimit

public org.eclipse.milo.opcua.stack.core.types.enumerated.ConversionLimitEnum getConversionLimit()
                                                                                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerUnitType

Get the local value of the ConversionLimit Node.

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

Specified by:

getConversionLimit in interface ServerUnitType

Returns:

the local value of the ConversionLimit Node.

Throws:

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

setConversionLimit

public void setConversionLimit(org.eclipse.milo.opcua.stack.core.types.enumerated.ConversionLimitEnum value)
                        throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerUnitType

Set the local value of the ConversionLimit Node.

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

Specified by:

setConversionLimit in interface ServerUnitType

Parameters:

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

Throws:

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

readConversionLimit

public org.eclipse.milo.opcua.stack.core.types.enumerated.ConversionLimitEnum readConversionLimit()
                                                                                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerUnitType

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

Specified by:

readConversionLimit in interface ServerUnitType

Returns:

the ConversionLimitEnum value read from the server.

Throws:

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

writeConversionLimit

public void writeConversionLimit(org.eclipse.milo.opcua.stack.core.types.enumerated.ConversionLimitEnum value)
                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerUnitType

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

Specified by:

writeConversionLimit in interface ServerUnitType

Parameters:

value - the ConversionLimitEnum value to write to the server.

Throws:

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

readConversionLimitAsync

public CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.enumerated.ConversionLimitEnum> readConversionLimitAsync()

Description copied from interface: ServerUnitType

An asynchronous implementation of ServerUnitType.readConversionLimit().

Specified by:

readConversionLimitAsync in interface ServerUnitType

Returns:

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

writeConversionLimitAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeConversionLimitAsync(org.eclipse.milo.opcua.stack.core.types.enumerated.ConversionLimitEnum conversionLimit)

Description copied from interface: ServerUnitType

An asynchronous implementation of ServerUnitType.writeConversionLimit(org.eclipse.milo.opcua.stack.core.types.enumerated.ConversionLimitEnum).

Specified by:

writeConversionLimitAsync in interface ServerUnitType

Returns:

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

getConversionLimitNode

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

Description copied from interface: ServerUnitType

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

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

Specified by:

getConversionLimitNode in interface ServerUnitType

Returns:

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

getConversionLimitNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getConversionLimitNodeAsync()

Description copied from interface: ServerUnitType

Asynchronous implementation of ServerUnitType.getConversionLimitNode().

Specified by:

getConversionLimitNodeAsync in interface ServerUnitType

Returns:

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

getAlternativeUnitsNode

public BaseObjectTypeNode getAlternativeUnitsNode()
                                           throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerUnitType

Get the AlternativeUnits BaseObjectType Node, or null if it does not exist.

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

Specified by:

getAlternativeUnitsNode in interface ServerUnitType

Returns:

the AlternativeUnits BaseObjectType 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.

getAlternativeUnitsNodeAsync

public CompletableFuture<? extends BaseObjectTypeNode> getAlternativeUnitsNodeAsync()

Description copied from interface: ServerUnitType

Asynchronous implementation of ServerUnitType.getAlternativeUnitsNode().

Specified by:

getAlternativeUnitsNodeAsync in interface ServerUnitType

Returns:

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

getCoherentUnitNode

public UnitTypeNode getCoherentUnitNode()
                                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: ServerUnitType

Get the CoherentUnit UnitType Node, or null if it does not exist.

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

Specified by:

getCoherentUnitNode in interface ServerUnitType

Returns:

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

getCoherentUnitNodeAsync

public CompletableFuture<? extends UnitTypeNode> getCoherentUnitNodeAsync()

Description copied from interface: ServerUnitType

Asynchronous implementation of ServerUnitType.getCoherentUnitNode().

Specified by:

getCoherentUnitNodeAsync in interface ServerUnitType

Returns:

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