Module org.eclipse.milo.opcua.sdk.client
Package org.eclipse.milo.opcua.sdk.client.model.objects

Interface StateMachineType

All Superinterfaces:
BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Subinterfaces:
ExclusiveLimitStateMachineType, FileTransferStateMachineType, FiniteStateMachineType, ProgramStateMachineType, ShelvedStateMachineType
All Known Implementing Classes:
ExclusiveLimitStateMachineTypeNode, FileTransferStateMachineTypeNode, FiniteStateMachineTypeNode, ProgramStateMachineTypeNode, ShelvedStateMachineTypeNode, StateMachineTypeNode
public interface StateMachineType extends BaseObjectType
See Also:

  • Method Details

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

      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 value) 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.

      Parameters:
      value - 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.
      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 value) 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.
      Parameters:
      value - 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().
      Returns:
      a CompletableFuture that completes successfully with the 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 value)
      An asynchronous implementation of writeCurrentState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getCurrentStateNode

      StateVariableType getCurrentStateNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the CurrentState StateVariableType Node, or null if it does not exist.

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

      Returns:
      the CurrentState StateVariableType 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 StateVariableType> getCurrentStateNodeAsync()
      Asynchronous implementation of getCurrentStateNode().
      Returns:
      a CompletableFuture that completes successfully with the StateVariableType 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.

      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 value) 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.

      Parameters:
      value - 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.
      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 value) 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.
      Parameters:
      value - 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().
      Returns:
      a CompletableFuture that completes successfully with the 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 value)
      An asynchronous implementation of writeLastTransition(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getLastTransitionNode

      TransitionVariableType getLastTransitionNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the LastTransition TransitionVariableType Node, or null if it does not exist.

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

      Returns:
      the LastTransition TransitionVariableType 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 TransitionVariableType> getLastTransitionNodeAsync()
      Asynchronous implementation of getLastTransitionNode().
      Returns:
      a CompletableFuture that completes successfully with the TransitionVariableType Node or completes exceptionally if an error occurs creating or getting the Node.