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

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

Class AlternativeUnitTypeNode

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

All Implemented Interfaces:

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

public class AlternativeUnitTypeNode
extends UnitTypeNode
implements AlternativeUnitType

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

LINEAR_CONVERSION, MATH_ML_CONVERSION, MATH_ML_INVERSE_CONVERSION

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

DISCIPLINE, SYMBOL, UNIT_SYSTEM

Constructor Summary

Constructors

Constructor

Description

AlternativeUnitTypeNode(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.LinearConversionDataType	getLinearConversion()	Get the local value of the LinearConversion Node.
PropertyTypeNode	getLinearConversionNode()	Get the LinearConversion PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getLinearConversionNodeAsync()	Asynchronous implementation of AlternativeUnitType.getLinearConversionNode().
String	getMathMlConversion()	Get the local value of the MathMLConversion Node.
PropertyTypeNode	getMathMlConversionNode()	Get the MathMLConversion PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getMathMlConversionNodeAsync()	Asynchronous implementation of AlternativeUnitType.getMathMlConversionNode().
String	getMathMlInverseConversion()	Get the local value of the MathMLInverseConversion Node.
PropertyTypeNode	getMathMlInverseConversionNode()	Get the MathMLInverseConversion PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyTypeNode>	getMathMlInverseConversionNodeAsync()	Asynchronous implementation of AlternativeUnitType.getMathMlInverseConversionNode().
org.eclipse.milo.opcua.stack.core.types.structured.LinearConversionDataType	readLinearConversion()	Read the value of the LinearConversion Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.LinearConversionDataType>	readLinearConversionAsync()	An asynchronous implementation of AlternativeUnitType.readLinearConversion().
String	readMathMlConversion()	Read the value of the MathMLConversion Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readMathMlConversionAsync()	An asynchronous implementation of AlternativeUnitType.readMathMlConversion().
String	readMathMlInverseConversion()	Read the value of the MathMLInverseConversion Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readMathMlInverseConversionAsync()	An asynchronous implementation of AlternativeUnitType.readMathMlInverseConversion().
void	setLinearConversion(org.eclipse.milo.opcua.stack.core.types.structured.LinearConversionDataType value)	Set the local value of the LinearConversion Node.
void	setMathMlConversion(String value)	Set the local value of the MathMLConversion Node.
void	setMathMlInverseConversion(String value)	Set the local value of the MathMLInverseConversion Node.
void	writeLinearConversion(org.eclipse.milo.opcua.stack.core.types.structured.LinearConversionDataType value)	Write a new value for the LinearConversion Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeLinearConversionAsync(org.eclipse.milo.opcua.stack.core.types.structured.LinearConversionDataType linearConversion)	An asynchronous implementation of AlternativeUnitType.writeLinearConversion(org.eclipse.milo.opcua.stack.core.types.structured.LinearConversionDataType).
void	writeMathMlConversion(String value)	Write a new value for the MathMLConversion Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeMathMlConversionAsync(String mathMlConversion)	An asynchronous implementation of AlternativeUnitType.writeMathMlConversion(java.lang.String).
void	writeMathMlInverseConversion(String value)	Write a new value for the MathMLInverseConversion Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeMathMlInverseConversionAsync(String mathMlInverseConversion)	An asynchronous implementation of AlternativeUnitType.writeMathMlInverseConversion(java.lang.String).

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

AlternativeUnitTypeNode

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

getLinearConversion

public org.eclipse.milo.opcua.stack.core.types.structured.LinearConversionDataType getLinearConversion()
                                                                                                throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlternativeUnitType

Get the local value of the LinearConversion Node.

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

Specified by:

getLinearConversion in interface AlternativeUnitType

Returns:

the local value of the LinearConversion Node.

Throws:

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

setLinearConversion

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

Description copied from interface: AlternativeUnitType

Set the local value of the LinearConversion Node.

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

Specified by:

setLinearConversion in interface AlternativeUnitType

Parameters:

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

Throws:

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

readLinearConversion

public org.eclipse.milo.opcua.stack.core.types.structured.LinearConversionDataType readLinearConversion()
                                                                                                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: AlternativeUnitType

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

Specified by:

readLinearConversion in interface AlternativeUnitType

Returns:

the LinearConversionDataType value read from the server.

Throws:

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

writeLinearConversion

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

Description copied from interface: AlternativeUnitType

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

Specified by:

writeLinearConversion in interface AlternativeUnitType

Parameters:

value - the LinearConversionDataType value to write to the server.

Throws:

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

readLinearConversionAsync

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

Description copied from interface: AlternativeUnitType

An asynchronous implementation of AlternativeUnitType.readLinearConversion().

Specified by:

readLinearConversionAsync in interface AlternativeUnitType

Returns:

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

writeLinearConversionAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeLinearConversionAsync(org.eclipse.milo.opcua.stack.core.types.structured.LinearConversionDataType linearConversion)

Description copied from interface: AlternativeUnitType

An asynchronous implementation of AlternativeUnitType.writeLinearConversion(org.eclipse.milo.opcua.stack.core.types.structured.LinearConversionDataType).

Specified by:

writeLinearConversionAsync in interface AlternativeUnitType

Returns:

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

getLinearConversionNode

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

Description copied from interface: AlternativeUnitType

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

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

Specified by:

getLinearConversionNode in interface AlternativeUnitType

Returns:

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

getLinearConversionNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getLinearConversionNodeAsync()

Description copied from interface: AlternativeUnitType

Asynchronous implementation of AlternativeUnitType.getLinearConversionNode().

Specified by:

getLinearConversionNodeAsync in interface AlternativeUnitType

Returns:

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

getMathMlConversion

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

Description copied from interface: AlternativeUnitType

Get the local value of the MathMLConversion Node.

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

Specified by:

getMathMlConversion in interface AlternativeUnitType

Returns:

the local value of the MathMLConversion Node.

Throws:

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

setMathMlConversion

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

Description copied from interface: AlternativeUnitType

Set the local value of the MathMLConversion Node.

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

Specified by:

setMathMlConversion in interface AlternativeUnitType

Parameters:

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

Throws:

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

readMathMlConversion

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

Description copied from interface: AlternativeUnitType

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

Specified by:

readMathMlConversion in interface AlternativeUnitType

Returns:

the String value read from the server.

Throws:

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

writeMathMlConversion

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

Description copied from interface: AlternativeUnitType

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

Specified by:

writeMathMlConversion in interface AlternativeUnitType

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.

readMathMlConversionAsync

public CompletableFuture<? extends String> readMathMlConversionAsync()

Description copied from interface: AlternativeUnitType

An asynchronous implementation of AlternativeUnitType.readMathMlConversion().

Specified by:

readMathMlConversionAsync in interface AlternativeUnitType

Returns:

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

writeMathMlConversionAsync

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

Description copied from interface: AlternativeUnitType

An asynchronous implementation of AlternativeUnitType.writeMathMlConversion(java.lang.String).

Specified by:

writeMathMlConversionAsync in interface AlternativeUnitType

Returns:

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

getMathMlConversionNode

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

Description copied from interface: AlternativeUnitType

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

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

Specified by:

getMathMlConversionNode in interface AlternativeUnitType

Returns:

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

getMathMlConversionNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getMathMlConversionNodeAsync()

Description copied from interface: AlternativeUnitType

Asynchronous implementation of AlternativeUnitType.getMathMlConversionNode().

Specified by:

getMathMlConversionNodeAsync in interface AlternativeUnitType

Returns:

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

getMathMlInverseConversion

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

Description copied from interface: AlternativeUnitType

Get the local value of the MathMLInverseConversion Node.

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

Specified by:

getMathMlInverseConversion in interface AlternativeUnitType

Returns:

the local value of the MathMLInverseConversion Node.

Throws:

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

setMathMlInverseConversion

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

Description copied from interface: AlternativeUnitType

Set the local value of the MathMLInverseConversion Node.

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

Specified by:

setMathMlInverseConversion in interface AlternativeUnitType

Parameters:

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

Throws:

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

readMathMlInverseConversion

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

Description copied from interface: AlternativeUnitType

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

Specified by:

readMathMlInverseConversion in interface AlternativeUnitType

Returns:

the String value read from the server.

Throws:

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

writeMathMlInverseConversion

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

Description copied from interface: AlternativeUnitType

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

Specified by:

writeMathMlInverseConversion in interface AlternativeUnitType

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.

readMathMlInverseConversionAsync

public CompletableFuture<? extends String> readMathMlInverseConversionAsync()

Description copied from interface: AlternativeUnitType

An asynchronous implementation of AlternativeUnitType.readMathMlInverseConversion().

Specified by:

readMathMlInverseConversionAsync in interface AlternativeUnitType

Returns:

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

writeMathMlInverseConversionAsync

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

Description copied from interface: AlternativeUnitType

An asynchronous implementation of AlternativeUnitType.writeMathMlInverseConversion(java.lang.String).

Specified by:

writeMathMlInverseConversionAsync in interface AlternativeUnitType

Returns:

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

getMathMlInverseConversionNode

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

Description copied from interface: AlternativeUnitType

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

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

Specified by:

getMathMlInverseConversionNode in interface AlternativeUnitType

Returns:

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

getMathMlInverseConversionNodeAsync

public CompletableFuture<? extends PropertyTypeNode> getMathMlInverseConversionNodeAsync()

Description copied from interface: AlternativeUnitType

Asynchronous implementation of AlternativeUnitType.getMathMlInverseConversionNode().

Specified by:

getMathMlInverseConversionNodeAsync in interface AlternativeUnitType

Returns:

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