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

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

Interface RationalNumberType

All Superinterfaces:

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

All Known Implementing Classes:

RationalNumberTypeNode

public interface RationalNumberType
extends BaseDataVariableType

See Also:

• https://reference.opcfoundation.org/v105/Core/docs/Part5/7.20

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.
BaseDataVariableType	getDenominatorNode()	Get the Denominator BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getDenominatorNodeAsync()	Asynchronous implementation of getDenominatorNode().
Integer	getNumerator()	Get the local value of the Numerator Node.
BaseDataVariableType	getNumeratorNode()	Get the Numerator BaseDataVariableType Node, or null if it does not exist.
CompletableFuture<? extends BaseDataVariableType>	getNumeratorNodeAsync()	Asynchronous implementation of 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 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 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 value)	An asynchronous implementation of 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 value)	An asynchronous implementation of writeNumerator(java.lang.Integer).

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

Method Details

getNumerator

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

Get the local value of the Numerator Node.

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

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

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

Set the local value of the Numerator Node.

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

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

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

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

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

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

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

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

CompletableFuture<? extends Integer> readNumeratorAsync()

An asynchronous implementation of readNumerator().

Returns:

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

writeNumeratorAsync

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

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

Returns:

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

getNumeratorNode

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

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

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

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

CompletableFuture<? extends BaseDataVariableType> getNumeratorNodeAsync()

Asynchronous implementation of getNumeratorNode().

Returns:

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

getDenominator

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

Get the local value of the Denominator Node.

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

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

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

Set the local value of the Denominator Node.

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

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

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

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

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

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

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

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

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

An asynchronous implementation of readDenominator().

Returns:

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

writeDenominatorAsync

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

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

Returns:

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

getDenominatorNode

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

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

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

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

CompletableFuture<? extends BaseDataVariableType> getDenominatorNodeAsync()

Asynchronous implementation of getDenominatorNode().

Returns:

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