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

Interface FiniteStateMachineType

All Superinterfaces:
BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode, StateMachineType
All Known Subinterfaces:
ExclusiveLimitStateMachineType, FileTransferStateMachineType, ProgramStateMachineType, ShelvedStateMachineType
All Known Implementing Classes:
ExclusiveLimitStateMachineTypeNode, FileTransferStateMachineTypeNode, FiniteStateMachineTypeNode, ProgramStateMachineTypeNode, ShelvedStateMachineTypeNode
public interface FiniteStateMachineType extends StateMachineType
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.

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

      Specified by:
      setCurrentState in interface StateMachineType
      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.
      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 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.
      Specified by:
      writeCurrentState in interface StateMachineType
      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().
      Specified by:
      readCurrentStateAsync in interface StateMachineType
      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).
      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 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 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.

      Specified by:
      setLastTransition in interface StateMachineType
      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.
      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 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.
      Specified by:
      writeLastTransition in interface StateMachineType
      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().
      Specified by:
      readLastTransitionAsync in interface StateMachineType
      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).
      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 FiniteTransitionVariableType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getAvailableStates

      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[] getAvailableStates() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the AvailableStates Node.

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

      Returns:
      the local value of the AvailableStates Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the AvailableStates Node.

    • setAvailableStates

      void setAvailableStates(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the AvailableStates Node.

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

      Parameters:
      value - the local value to set for the AvailableStates Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the AvailableStates Node.

    • readAvailableStates

      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[] readAvailableStates() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the AvailableStates Node from the server and update the local value if the operation succeeds.
      Returns:
      the NodeId value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeAvailableStates

      void writeAvailableStates(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the AvailableStates Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the NodeId value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readAvailableStatesAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[]> readAvailableStatesAsync()
      An asynchronous implementation of readAvailableStates().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeAvailableStatesAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeAvailableStatesAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[] value)
      An asynchronous implementation of writeAvailableStates(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[]).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getAvailableStatesNode

      BaseDataVariableType getAvailableStatesNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the AvailableStates BaseDataVariableType Node, or null if it does not exist.

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

      Returns:
      the AvailableStates 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.

    • getAvailableStatesNodeAsync

      CompletableFuture<? extends BaseDataVariableType> getAvailableStatesNodeAsync()
      Asynchronous implementation of getAvailableStatesNode().
      Returns:
      a CompletableFuture that completes successfully with the BaseDataVariableType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getAvailableTransitions

      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[] getAvailableTransitions() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the AvailableTransitions Node.

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

      Returns:
      the local value of the AvailableTransitions Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the AvailableTransitions Node.

    • setAvailableTransitions

      void setAvailableTransitions(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the AvailableTransitions Node.

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

      Parameters:
      value - the local value to set for the AvailableTransitions Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the AvailableTransitions Node.

    • readAvailableTransitions

      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[] readAvailableTransitions() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the AvailableTransitions Node from the server and update the local value if the operation succeeds.
      Returns:
      the NodeId value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeAvailableTransitions

      void writeAvailableTransitions(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the AvailableTransitions Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the NodeId value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readAvailableTransitionsAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[]> readAvailableTransitionsAsync()
      An asynchronous implementation of readAvailableTransitions().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeAvailableTransitionsAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeAvailableTransitionsAsync(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[] value)
      An asynchronous implementation of writeAvailableTransitions(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[]).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getAvailableTransitionsNode

      BaseDataVariableType getAvailableTransitionsNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the AvailableTransitions BaseDataVariableType Node, or null if it does not exist.

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

      Returns:
      the AvailableTransitions 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.

    • getAvailableTransitionsNodeAsync

      CompletableFuture<? extends BaseDataVariableType> getAvailableTransitionsNodeAsync()
      Asynchronous implementation of getAvailableTransitionsNode().
      Returns:
      a CompletableFuture that completes successfully with the BaseDataVariableType Node or completes exceptionally if an error occurs creating or getting the Node.