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

Interface FiniteStateMachineType

All Superinterfaces:

BaseObjectType, Node, ObjectNode, StateMachineType

All Known Subinterfaces:

ExclusiveLimitStateMachineType, ProgramStateMachineType, ShelvedStateMachineType

All Known Implementing Classes:

ExclusiveLimitStateMachineTypeNode, FiniteStateMachineTypeNode, ProgramStateMachineTypeNode, ShelvedStateMachineTypeNode

public interface FiniteStateMachineType
extends StateMachineType

Method Summary

Modifier and Type	Method and Description
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getCurrentState() Get the local value of the CurrentState Node.
FiniteStateVariableType	getCurrentStateNode() Get the CurrentState FiniteStateVariableType Node, or null if it does not exist.
CompletableFuture<? extends FiniteStateVariableType>	getCurrentStateNodeAsync() Asynchronous implementation of getCurrentStateNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getLastTransition() Get the local value of the LastTransition Node.
FiniteTransitionVariableType	getLastTransitionNode() Get the LastTransition FiniteTransitionVariableType Node, or null if it does not exist.
CompletableFuture<? extends FiniteTransitionVariableType>	getLastTransitionNodeAsync() Asynchronous implementation of getLastTransitionNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readCurrentState() Read the value of the CurrentState Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readCurrentStateAsync() An asynchronous implementation of readCurrentState().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readLastTransition() Read the value of the LastTransition Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readLastTransitionAsync() An asynchronous implementation of readLastTransition().
void	setCurrentState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText currentState) Set the local value of the CurrentState Node.
void	setLastTransition(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText lastTransition) Set the local value of the LastTransition Node.
void	writeCurrentState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText currentState) Write a new value for the CurrentState Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeCurrentStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText currentState) An asynchronous implementation of writeCurrentState(LocalizedText).
void	writeLastTransition(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText lastTransition) Write a new value for the LastTransition Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeLastTransitionAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText lastTransition) An asynchronous implementation of writeLastTransition(LocalizedText).

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

Method Detail

getCurrentState

org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getCurrentState()
                                                                       throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the CurrentState Node.

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

Specified by:

getCurrentState in interface StateMachineType

Returns:

the local value of the CurrentState Node.

Throws:

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

setCurrentState

void setCurrentState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText currentState)
              throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the CurrentState Node.

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

Specified by:

setCurrentState in interface StateMachineType

Parameters:

currentState - the local value to set for the CurrentState Node.

Throws:

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

readCurrentState

org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readCurrentState()
                                                                        throws org.eclipse.milo.opcua.stack.core.UaException

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

Specified by:

readCurrentState in interface StateMachineType

Returns:

the LocalizedText value read from the server.

Throws:

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

writeCurrentState

void writeCurrentState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText currentState)
                throws org.eclipse.milo.opcua.stack.core.UaException

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

Specified by:

writeCurrentState in interface StateMachineType

Parameters:

currentState - the LocalizedText value to write to the server.

Throws:

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

readCurrentStateAsync

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

An asynchronous implementation of readCurrentState().

Specified by:

readCurrentStateAsync in interface StateMachineType

Returns:

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

writeCurrentStateAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeCurrentStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText currentState)

An asynchronous implementation of writeCurrentState(LocalizedText).

Specified by:

writeCurrentStateAsync in interface StateMachineType

Returns:

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

getCurrentStateNode

FiniteStateVariableType getCurrentStateNode()
                                     throws org.eclipse.milo.opcua.stack.core.UaException

Get the CurrentState FiniteStateVariableType Node, or null if it does not exist.

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

Specified by:

getCurrentStateNode in interface StateMachineType

Returns:

the CurrentState FiniteStateVariableType 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.

getCurrentStateNodeAsync

CompletableFuture<? extends FiniteStateVariableType> getCurrentStateNodeAsync()

Asynchronous implementation of getCurrentStateNode().

Specified by:

getCurrentStateNodeAsync in interface StateMachineType

Returns:

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

getLastTransition

org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getLastTransition()
                                                                         throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the LastTransition Node.

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

Specified by:

getLastTransition in interface StateMachineType

Returns:

the local value of the LastTransition Node.

Throws:

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

setLastTransition

void setLastTransition(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText lastTransition)
                throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the LastTransition Node.

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

Specified by:

setLastTransition in interface StateMachineType

Parameters:

lastTransition - the local value to set for the LastTransition Node.

Throws:

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

readLastTransition

org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readLastTransition()
                                                                          throws org.eclipse.milo.opcua.stack.core.UaException

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

Specified by:

readLastTransition in interface StateMachineType

Returns:

the LocalizedText value read from the server.

Throws:

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

writeLastTransition

void writeLastTransition(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText lastTransition)
                  throws org.eclipse.milo.opcua.stack.core.UaException

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

Specified by:

writeLastTransition in interface StateMachineType

Parameters:

lastTransition - the LocalizedText value to write to the server.

Throws:

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

readLastTransitionAsync

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

An asynchronous implementation of readLastTransition().

Specified by:

readLastTransitionAsync in interface StateMachineType

Returns:

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

writeLastTransitionAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeLastTransitionAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText lastTransition)

An asynchronous implementation of writeLastTransition(LocalizedText).

Specified by:

writeLastTransitionAsync in interface StateMachineType

Returns:

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

getLastTransitionNode

FiniteTransitionVariableType getLastTransitionNode()
                                            throws org.eclipse.milo.opcua.stack.core.UaException

Get the LastTransition FiniteTransitionVariableType Node, or null if it does not exist.

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

Specified by:

getLastTransitionNode in interface StateMachineType

Returns:

the LastTransition FiniteTransitionVariableType 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.

getLastTransitionNodeAsync

CompletableFuture<? extends FiniteTransitionVariableType> getLastTransitionNodeAsync()

Asynchronous implementation of getLastTransitionNode().

Specified by:

getLastTransitionNodeAsync in interface StateMachineType

Returns:

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