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

Interface ProgramStateMachineType

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:
ProgramStateMachineTypeNode
public interface ProgramStateMachineType extends FiniteStateMachineType
See Also:

  • Field Details

    • CREATABLE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Boolean> CREATABLE

    • DELETABLE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Boolean> DELETABLE

    • AUTO_DELETE

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Boolean> AUTO_DELETE

    • RECYCLE_COUNT

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Integer> RECYCLE_COUNT

    • INSTANCE_COUNT

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> INSTANCE_COUNT

    • MAX_INSTANCE_COUNT

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> MAX_INSTANCE_COUNT

    • MAX_RECYCLE_COUNT

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> MAX_RECYCLE_COUNT

  • Method Details

    • getCreatable

      Boolean getCreatable() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Creatable Node.

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

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

    • setCreatable

      void setCreatable(Boolean value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Creatable Node.

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

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

    • readCreatable

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

    • writeCreatable

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

    • readCreatableAsync

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

    • writeCreatableAsync

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

    • getCreatableNode

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

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

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

    • getCreatableNodeAsync

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

    • getDeletable

      Boolean getDeletable() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Deletable Node.

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

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

    • setDeletable

      void setDeletable(Boolean value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Deletable Node.

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

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

    • readDeletable

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

    • writeDeletable

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

    • readDeletableAsync

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

    • writeDeletableAsync

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

    • getDeletableNode

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

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

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

    • getDeletableNodeAsync

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

    • getAutoDelete

      Boolean getAutoDelete() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the AutoDelete Node.

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

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

    • setAutoDelete

      void setAutoDelete(Boolean value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the AutoDelete Node.

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

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

    • readAutoDelete

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

    • writeAutoDelete

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

    • readAutoDeleteAsync

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

    • writeAutoDeleteAsync

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

    • getAutoDeleteNode

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

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

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

    • getAutoDeleteNodeAsync

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

    • getRecycleCount

      Integer getRecycleCount() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the RecycleCount Node.

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

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

    • setRecycleCount

      void setRecycleCount(Integer value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the RecycleCount Node.

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

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

    • readRecycleCount

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

    • writeRecycleCount

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

    • readRecycleCountAsync

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

    • writeRecycleCountAsync

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

    • getRecycleCountNode

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

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

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

    • getRecycleCountNodeAsync

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

    • getInstanceCount

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getInstanceCount() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the InstanceCount Node.

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

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

    • setInstanceCount

      void setInstanceCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the InstanceCount Node.

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

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

    • readInstanceCount

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

    • writeInstanceCount

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

    • readInstanceCountAsync

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

    • writeInstanceCountAsync

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

    • getInstanceCountNode

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

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

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

    • getInstanceCountNodeAsync

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

    • getMaxInstanceCount

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getMaxInstanceCount() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the MaxInstanceCount Node.

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

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

    • setMaxInstanceCount

      void setMaxInstanceCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the MaxInstanceCount Node.

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

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

    • readMaxInstanceCount

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

    • writeMaxInstanceCount

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

    • readMaxInstanceCountAsync

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

    • writeMaxInstanceCountAsync

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

    • getMaxInstanceCountNode

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

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

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

    • getMaxInstanceCountNodeAsync

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

    • getMaxRecycleCount

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getMaxRecycleCount() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the MaxRecycleCount Node.

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

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

    • setMaxRecycleCount

      void setMaxRecycleCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the MaxRecycleCount Node.

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

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

    • readMaxRecycleCount

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

    • writeMaxRecycleCount

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

    • readMaxRecycleCountAsync

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

    • writeMaxRecycleCountAsync

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

    • getMaxRecycleCountNode

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

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

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

    • getMaxRecycleCountNodeAsync

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

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

    • getProgramDiagnostic

      org.eclipse.milo.opcua.stack.core.types.structured.ProgramDiagnostic2DataType getProgramDiagnostic() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the ProgramDiagnostic Node.

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

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

    • setProgramDiagnostic

      void setProgramDiagnostic(org.eclipse.milo.opcua.stack.core.types.structured.ProgramDiagnostic2DataType value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the ProgramDiagnostic Node.

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

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

    • readProgramDiagnostic

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

    • writeProgramDiagnostic

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

    • readProgramDiagnosticAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.structured.ProgramDiagnostic2DataType> readProgramDiagnosticAsync()
      An asynchronous implementation of readProgramDiagnostic().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeProgramDiagnosticAsync

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

    • getProgramDiagnosticNode

      ProgramDiagnostic2Type getProgramDiagnosticNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the ProgramDiagnostic ProgramDiagnostic2Type Node, or null if it does not exist.

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

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

    • getProgramDiagnosticNodeAsync

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

    • getFinalResultDataNode

      BaseObjectType getFinalResultDataNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the FinalResultData BaseObjectType Node, or null if it does not exist.

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

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

    • getFinalResultDataNodeAsync

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

    • getHaltedNode

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

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

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

    • getHaltedNodeAsync

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

    • getReadyNode

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

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

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

    • getReadyNodeAsync

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

    • getRunningNode

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

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

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

    • getRunningNodeAsync

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

    • getSuspendedNode

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

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

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

    • getSuspendedNodeAsync

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

    • getHaltedToReadyNode

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

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

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

    • getHaltedToReadyNodeAsync

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

    • getReadyToRunningNode

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

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

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

    • getReadyToRunningNodeAsync

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

    • getRunningToHaltedNode

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

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

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

    • getRunningToHaltedNodeAsync

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

    • getRunningToReadyNode

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

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

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

    • getRunningToReadyNodeAsync

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

    • getRunningToSuspendedNode

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

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

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

    • getRunningToSuspendedNodeAsync

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

    • getSuspendedToRunningNode

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

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

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

    • getSuspendedToRunningNodeAsync

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

    • getSuspendedToHaltedNode

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

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

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

    • getSuspendedToHaltedNodeAsync

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

    • getSuspendedToReadyNode

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

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

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

    • getSuspendedToReadyNodeAsync

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

    • getReadyToHaltedNode

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

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

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

    • getReadyToHaltedNodeAsync

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