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

Interface OptionSetType

All Superinterfaces:
BaseDataVariableType, BaseVariableType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode
All Known Implementing Classes:
OptionSetTypeNode
public interface OptionSetType extends BaseDataVariableType
See Also:

  • Field Details

    • OPTION_SET_VALUES

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]> OPTION_SET_VALUES

    • BIT_MASK

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Boolean[]> BIT_MASK

  • Method Details

    • getOptionSetValues

      org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] getOptionSetValues() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the OptionSetValues Node.

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

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

    • setOptionSetValues

      void setOptionSetValues(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the OptionSetValues Node.

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

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

    • readOptionSetValues

      org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] readOptionSetValues() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the OptionSetValues 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.

    • writeOptionSetValues

      void writeOptionSetValues(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the OptionSetValues 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.

    • readOptionSetValuesAsync

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

    • writeOptionSetValuesAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeOptionSetValuesAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] value)
      An asynchronous implementation of writeOptionSetValues(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.

    • getOptionSetValuesNode

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

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

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

    • getOptionSetValuesNodeAsync

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

    • getBitMask

      Boolean[] getBitMask() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the BitMask Node.

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

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

    • setBitMask

      void setBitMask(Boolean[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the BitMask Node.

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

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

    • readBitMask

      Boolean[] readBitMask() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the BitMask 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.

    • writeBitMask

      void writeBitMask(Boolean[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the BitMask 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.

    • readBitMaskAsync

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

    • writeBitMaskAsync

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

    • getBitMaskNode

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

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

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

    • getBitMaskNodeAsync

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