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

Interface ShelvedStateMachineType

All Superinterfaces:
BaseObjectType, FiniteStateMachineType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode, StateMachineType
All Known Implementing Classes:
ShelvedStateMachineTypeNode
public interface ShelvedStateMachineType extends FiniteStateMachineType
See Also:

  • Field Details

    • UNSHELVE_TIME

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Double> UNSHELVE_TIME

  • Method Details

    • getUnshelveTime

      Double getUnshelveTime() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the UnshelveTime Node.

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

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

    • setUnshelveTime

      void setUnshelveTime(Double value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the UnshelveTime Node.

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

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

    • readUnshelveTime

      Double readUnshelveTime() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the UnshelveTime Node from the server and update the local value if the operation succeeds.
      Returns:
      the Double value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeUnshelveTime

      void writeUnshelveTime(Double value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the UnshelveTime Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the Double value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readUnshelveTimeAsync

      CompletableFuture<? extends Double> readUnshelveTimeAsync()
      An asynchronous implementation of readUnshelveTime().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeUnshelveTimeAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeUnshelveTimeAsync(Double value)
      An asynchronous implementation of writeUnshelveTime(java.lang.Double).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getUnshelveTimeNode

      PropertyType getUnshelveTimeNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the UnshelveTime PropertyType Node, or null if it does not exist.

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

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

    • getUnshelveTimeNodeAsync

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

    • getUnshelvedNode

      StateType getUnshelvedNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the Unshelved StateType Node, or null if it does not exist.

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

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

    • getUnshelvedNodeAsync

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

    • getTimedShelvedNode

      StateType getTimedShelvedNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the TimedShelved StateType Node, or null if it does not exist.

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

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

    • getTimedShelvedNodeAsync

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

    • getOneShotShelvedNode

      StateType getOneShotShelvedNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the OneShotShelved StateType Node, or null if it does not exist.

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

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

    • getOneShotShelvedNodeAsync

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

    • getUnshelvedToTimedShelvedNode

      TransitionType getUnshelvedToTimedShelvedNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the UnshelvedToTimedShelved TransitionType Node, or null if it does not exist.

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

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

    • getUnshelvedToTimedShelvedNodeAsync

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

    • getUnshelvedToOneShotShelvedNode

      TransitionType getUnshelvedToOneShotShelvedNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the UnshelvedToOneShotShelved TransitionType Node, or null if it does not exist.

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

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

    • getUnshelvedToOneShotShelvedNodeAsync

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

    • getTimedShelvedToUnshelvedNode

      TransitionType getTimedShelvedToUnshelvedNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the TimedShelvedToUnshelved TransitionType Node, or null if it does not exist.

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

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

    • getTimedShelvedToUnshelvedNodeAsync

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

    • getTimedShelvedToOneShotShelvedNode

      TransitionType getTimedShelvedToOneShotShelvedNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the TimedShelvedToOneShotShelved TransitionType Node, or null if it does not exist.

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

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

    • getTimedShelvedToOneShotShelvedNodeAsync

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

    • getOneShotShelvedToUnshelvedNode

      TransitionType getOneShotShelvedToUnshelvedNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the OneShotShelvedToUnshelved TransitionType Node, or null if it does not exist.

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

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

    • getOneShotShelvedToUnshelvedNodeAsync

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

    • getOneShotShelvedToTimedShelvedNode

      TransitionType getOneShotShelvedToTimedShelvedNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the OneShotShelvedToTimedShelved TransitionType Node, or null if it does not exist.

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

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

    • getOneShotShelvedToTimedShelvedNodeAsync

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