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

Interface FiniteStateVariableType

All Superinterfaces:

BaseDataVariableType, BaseVariableType, Node, StateVariableType, VariableNode

All Known Implementing Classes:

FiniteStateVariableTypeNode

public interface FiniteStateVariableType
extends StateVariableType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	ID

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.types.variables.StateVariableType

EFFECTIVE_DISPLAY_NAME, NAME, NUMBER

Method Summary

Modifier and Type	Method and Description
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	getId() Get the local value of the Id Node.
PropertyType	getIdNode() Get the Id PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getIdNodeAsync() Asynchronous implementation of getIdNode().
org.eclipse.milo.opcua.stack.core.types.builtin.NodeId	readId() Read the value of the Id Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId>	readIdAsync() An asynchronous implementation of readId().
void	setId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId id) Set the local value of the Id Node.
void	writeId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId id) Write a new value for the Id Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId id) An asynchronous implementation of writeId(NodeId).

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.types.variables.StateVariableType

getEffectiveDisplayName, getEffectiveDisplayNameNode, getEffectiveDisplayNameNodeAsync, getName, getNameNode, getNameNodeAsync, getNumber, getNumberNode, getNumberNodeAsync, readEffectiveDisplayName, readEffectiveDisplayNameAsync, readName, readNameAsync, readNumber, readNumberAsync, setEffectiveDisplayName, setId, setName, setNumber, writeEffectiveDisplayName, writeEffectiveDisplayNameAsync, writeId, writeIdAsync, writeName, writeNameAsync, writeNumber, writeNumberAsync

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

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

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

ID

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> ID

Method Detail

getId

org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getId()
                                                      throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the Id Node.

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

Specified by:

getId in interface StateVariableType

Returns:

the local value of the Id Node.

Throws:

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

setId

void setId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId id)
    throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the Id Node.

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

Parameters:

id - the local value to set for the Id Node.

Throws:

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

readId

org.eclipse.milo.opcua.stack.core.types.builtin.NodeId readId()
                                                       throws org.eclipse.milo.opcua.stack.core.UaException

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

Specified by:

readId in interface StateVariableType

Returns:

the NodeId value read from the server.

Throws:

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

writeId

void writeId(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId id)
      throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

id - the NodeId value to write to the server.

Throws:

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

readIdAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId> readIdAsync()

An asynchronous implementation of readId().

Specified by:

readIdAsync in interface StateVariableType

Returns:

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

writeIdAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId id)

An asynchronous implementation of writeId(NodeId).

Returns:

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

getIdNode

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

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

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

Specified by:

getIdNode in interface StateVariableType

Returns:

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

getIdNodeAsync

CompletableFuture<? extends PropertyType> getIdNodeAsync()

Asynchronous implementation of getIdNode().

Specified by:

getIdNodeAsync in interface StateVariableType

Returns:

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