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

Interface MultiStateDictionaryEntryDiscreteType

All Superinterfaces:
BaseDataVariableType, BaseVariableType, DataItemType, DiscreteItemType, MultiStateDictionaryEntryDiscreteBaseType, MultiStateValueDiscreteType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode
All Known Implementing Classes:
MultiStateDictionaryEntryDiscreteTypeNode
public interface MultiStateDictionaryEntryDiscreteType extends MultiStateDictionaryEntryDiscreteBaseType
See Also:

  • Field Details

    • VALUE_AS_DICTIONARY_ENTRIES

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

  • Method Details

    • getValueAsDictionaryEntries

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

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

      Specified by:
      getValueAsDictionaryEntries in interface MultiStateDictionaryEntryDiscreteBaseType
      Returns:
      the local value of the ValueAsDictionaryEntries Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ValueAsDictionaryEntries Node.

    • setValueAsDictionaryEntries

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

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

      Specified by:
      setValueAsDictionaryEntries in interface MultiStateDictionaryEntryDiscreteBaseType
      Parameters:
      value - the local value to set for the ValueAsDictionaryEntries Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the ValueAsDictionaryEntries Node.

    • readValueAsDictionaryEntries

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

    • writeValueAsDictionaryEntries

      void writeValueAsDictionaryEntries(org.eclipse.milo.opcua.stack.core.types.builtin.NodeId[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the ValueAsDictionaryEntries Node to the server and update the local value if the operation succeeds.
      Specified by:
      writeValueAsDictionaryEntries in interface MultiStateDictionaryEntryDiscreteBaseType
      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.

    • readValueAsDictionaryEntriesAsync

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

    • writeValueAsDictionaryEntriesAsync

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

    • getValueAsDictionaryEntriesNode

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

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

      Specified by:
      getValueAsDictionaryEntriesNode in interface MultiStateDictionaryEntryDiscreteBaseType
      Returns:
      the ValueAsDictionaryEntries 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.

    • getValueAsDictionaryEntriesNodeAsync

      CompletableFuture<? extends PropertyType> getValueAsDictionaryEntriesNodeAsync()
      Asynchronous implementation of getValueAsDictionaryEntriesNode().
      Specified by:
      getValueAsDictionaryEntriesNodeAsync in interface MultiStateDictionaryEntryDiscreteBaseType
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.