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

Interface StateType

All Superinterfaces:

BaseObjectType, Node, ObjectNode

All Known Subinterfaces:

InitialStateType

All Known Implementing Classes:

InitialStateTypeNode, StateTypeNode

public interface StateType
extends BaseObjectType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	STATE_NUMBER

Method Summary

Modifier and Type	Method and Description
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getStateNumber() Get the local value of the StateNumber Node.
PropertyType	getStateNumberNode() Get the StateNumber PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getStateNumberNodeAsync() Asynchronous implementation of getStateNumberNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	readStateNumber() Read the value of the StateNumber 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>	readStateNumberAsync() An asynchronous implementation of readStateNumber().
void	setStateNumber(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger stateNumber) Set the local value of the StateNumber Node.
void	writeStateNumber(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger stateNumber) Write a new value for the StateNumber Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeStateNumberAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger stateNumber) An asynchronous implementation of writeStateNumber(UInteger).

Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

getEventNotifier, setEventNotifier

Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.Node

getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getUserWriteMask, getWriteMask, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setUserWriteMask, setWriteMask

Field Detail

STATE_NUMBER

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> STATE_NUMBER

Method Detail

getStateNumber

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

Get the local value of the StateNumber Node.

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

Returns:

the local value of the StateNumber Node.

Throws:

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

setStateNumber

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

Set the local value of the StateNumber Node.

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

Parameters:

stateNumber - the local value to set for the StateNumber Node.

Throws:

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

readStateNumber

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

Read the value of the StateNumber 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.

writeStateNumber

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

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

Parameters:

stateNumber - the UInteger value to write to the server.

Throws:

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

readStateNumberAsync

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

An asynchronous implementation of readStateNumber().

Returns:

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

writeStateNumberAsync

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

An asynchronous implementation of writeStateNumber(UInteger).

Returns:

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

getStateNumberNode

PropertyType getStateNumberNode()
                         throws org.eclipse.milo.opcua.stack.core.UaException

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

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

Returns:

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

getStateNumberNodeAsync

CompletableFuture<? extends PropertyType> getStateNumberNodeAsync()

Asynchronous implementation of getStateNumberNode().

Returns:

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