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

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

Class RationalNumberTypeNode

java.lang.Object

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

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

org.eclipse.milo.opcua.sdk.client.model.variables.BaseVariableTypeNode

org.eclipse.milo.opcua.sdk.client.model.variables.BaseDataVariableTypeNode

org.eclipse.milo.opcua.sdk.client.model.variables.RationalNumberTypeNode

All Implemented Interfaces:

BaseDataVariableType, BaseVariableType, RationalNumberType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode

public class RationalNumberTypeNode
extends BaseDataVariableTypeNode
implements RationalNumberType

Field Summary

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

client

Constructor Summary

Constructors

Constructor

Description

RationalNumberTypeNode(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.DataValue value, org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType, Integer valueRank, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel, org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel, Double minimumSamplingInterval, Boolean historizing, org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx)

Method Summary

Modifier and Type	Method	Description
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getDenominator()	Get the local value of the Denominator Node.
BaseDataVariableTypeNode	getDenominatorNode()	Get the Denominator BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getDenominatorNodeAsync()	Asynchronous implementation of RationalNumberType.getDenominatorNode().
Integer	getNumerator()	Get the local value of the Numerator Node.
BaseDataVariableTypeNode	getNumeratorNode()	Get the Numerator BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableTypeNode>	getNumeratorNodeAsync()	Asynchronous implementation of RationalNumberType.getNumeratorNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	readDenominator()	Read the value of the Denominator Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	readDenominatorAsync()	An asynchronous implementation of RationalNumberType.readDenominator().
Integer	readNumerator()	Read the value of the Numerator Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Integer>	readNumeratorAsync()	An asynchronous implementation of RationalNumberType.readNumerator().
void	setDenominator(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)	Set the local value of the Denominator Node.
void	setNumerator(Integer value)	Set the local value of the Numerator Node.
void	writeDenominator(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)	Write a new value for the Denominator Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDenominatorAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger denominator)	An asynchronous implementation of RationalNumberType.writeDenominator(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).
void	writeNumerator(Integer value)	Write a new value for the Numerator Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeNumeratorAsync(Integer numerator)	An asynchronous implementation of RationalNumberType.writeNumerator(java.lang.Integer).

Methods inherited from class org.eclipse.milo.opcua.sdk.client.nodes.UaVariableNode

getAccessLevel, getAccessLevelEx, getArrayDimensions, getAttributeValue, getDataType, getHistorizing, getMinimumSamplingInterval, getTypeDefinition, getTypeDefinitionAsync, getUserAccessLevel, getValue, getValueRank, getVariableComponent, getVariableComponent, getVariableComponent, getVariableComponentAsync, getVariableComponentAsync, getVariableComponentAsync, readAccessLevel, readAccessLevelEx, readAllowNullsAsync, readArrayDimensions, readDataType, readDataTypeVersionAsync, readDictionaryFragmentAsync, readEngineeringUnitsAsync, readHistorizing, readLocalTimeAsync, readMaxArrayLengthAsync, readMaxStringLengthAsync, readMinimumSamplingInterval, readNodeVersionAsync, readUserAccessLevel, readValue, readValueAsTextAsync, readValueRank, setAccessLevel, setAccessLevelEx, setArrayDimensions, setAttributeValue, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValue, setValueRank, writeAccessLevel, writeAccessLevelEx, writeAllowNullsAsync, writeArrayDimensions, writeDataType, writeDataTypeVersionAsync, writeDictionaryFragmentAsync, writeEngineeringUnitsAsync, writeHistorizing, writeLocalTimeAsync, writeMaxArrayLengthAsync, writeMaxStringLengthAsync, writeMinimumSamplingInterval, writeNodeVersionAsync, writeUserAccessLevel, writeValue, writeValue, writeValueAsTextAsync, writeValueRank

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

getAccessLevel, getAccessLevelEx, getArrayDimensions, getDataType, getHistorizing, getMinimumSamplingInterval, getUserAccessLevel, getValue, getValueRank, setAccessLevel, setAccessLevelEx, setArrayDimensions, setDataType, setHistorizing, setMinimumSamplingInterval, setUserAccessLevel, setValue, setValueRank

Constructor Details

RationalNumberTypeNode

public RationalNumberTypeNode(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.DataValue value,
 org.eclipse.milo.opcua.stack.core.types.builtin.NodeId dataType,
 Integer valueRank,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger[] arrayDimensions,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte accessLevel,
 org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UByte userAccessLevel,
 Double minimumSamplingInterval,
 Boolean historizing,
 org.eclipse.milo.opcua.stack.core.types.structured.AccessLevelExType accessLevelEx)

Method Details

getNumerator

public Integer getNumerator()
                     throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RationalNumberType

Get the local value of the Numerator Node.

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

Specified by:

getNumerator in interface RationalNumberType

Returns:

the local value of the Numerator Node.

Throws:

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

setNumerator

public void setNumerator(Integer value)
                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RationalNumberType

Set the local value of the Numerator Node.

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

Specified by:

setNumerator in interface RationalNumberType

Parameters:

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

Throws:

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

readNumerator

public Integer readNumerator()
                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RationalNumberType

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

Specified by:

readNumerator in interface RationalNumberType

Returns:

the Integer value read from the server.

Throws:

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

writeNumerator

public void writeNumerator(Integer value)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RationalNumberType

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

Specified by:

writeNumerator in interface RationalNumberType

Parameters:

value - the Integer value to write to the server.

Throws:

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

readNumeratorAsync

public CompletableFuture<? extends Integer> readNumeratorAsync()

Description copied from interface: RationalNumberType

An asynchronous implementation of RationalNumberType.readNumerator().

Specified by:

readNumeratorAsync in interface RationalNumberType

Returns:

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

writeNumeratorAsync

public CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeNumeratorAsync(Integer numerator)

Description copied from interface: RationalNumberType

An asynchronous implementation of RationalNumberType.writeNumerator(java.lang.Integer).

Specified by:

writeNumeratorAsync in interface RationalNumberType

Returns:

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

getNumeratorNode

public BaseDataVariableTypeNode getNumeratorNode()
                                          throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RationalNumberType

Get the Numerator BaseDataVariableType Node, or null if it does not exist.

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

Specified by:

getNumeratorNode in interface RationalNumberType

Returns:

the Numerator BaseDataVariableType 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.

getNumeratorNodeAsync

public CompletableFuture<? extends BaseDataVariableTypeNode> getNumeratorNodeAsync()

Description copied from interface: RationalNumberType

Asynchronous implementation of RationalNumberType.getNumeratorNode().

Specified by:

getNumeratorNodeAsync in interface RationalNumberType

Returns:

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

getDenominator

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getDenominator()
                                                                                 throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RationalNumberType

Get the local value of the Denominator Node.

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

Specified by:

getDenominator in interface RationalNumberType

Returns:

the local value of the Denominator Node.

Throws:

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

setDenominator

public void setDenominator(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
                    throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RationalNumberType

Set the local value of the Denominator Node.

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

Specified by:

setDenominator in interface RationalNumberType

Parameters:

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

Throws:

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

readDenominator

public org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readDenominator()
                                                                                  throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RationalNumberType

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

Specified by:

readDenominator in interface RationalNumberType

Returns:

the UInteger value read from the server.

Throws:

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

writeDenominator

public void writeDenominator(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
                      throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RationalNumberType

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

Specified by:

writeDenominator in interface RationalNumberType

Parameters:

value - the UInteger value to write to the server.

Throws:

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

readDenominatorAsync

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

Description copied from interface: RationalNumberType

An asynchronous implementation of RationalNumberType.readDenominator().

Specified by:

readDenominatorAsync in interface RationalNumberType

Returns:

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

writeDenominatorAsync

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

Description copied from interface: RationalNumberType

An asynchronous implementation of RationalNumberType.writeDenominator(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger).

Specified by:

writeDenominatorAsync in interface RationalNumberType

Returns:

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

getDenominatorNode

public BaseDataVariableTypeNode getDenominatorNode()
                                            throws org.eclipse.milo.opcua.stack.core.UaException

Description copied from interface: RationalNumberType

Get the Denominator BaseDataVariableType Node, or null if it does not exist.

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

Specified by:

getDenominatorNode in interface RationalNumberType

Returns:

the Denominator BaseDataVariableType 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.

getDenominatorNodeAsync

public CompletableFuture<? extends BaseDataVariableTypeNode> getDenominatorNodeAsync()

Description copied from interface: RationalNumberType

Asynchronous implementation of RationalNumberType.getDenominatorNode().

Specified by:

getDenominatorNodeAsync in interface RationalNumberType

Returns:

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