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

Interface MultiStateDictionaryEntryDiscreteBaseType

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

  • Field Details

    • ENUM_DICTIONARY_ENTRIES

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Object> ENUM_DICTIONARY_ENTRIES

    • 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

    • getEnumDictionaryEntries

      Object getEnumDictionaryEntries() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the EnumDictionaryEntries Node.

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

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

    • setEnumDictionaryEntries

      void setEnumDictionaryEntries(Object value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the EnumDictionaryEntries Node.

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

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

    • readEnumDictionaryEntries

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

    • writeEnumDictionaryEntries

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

    • readEnumDictionaryEntriesAsync

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

    • writeEnumDictionaryEntriesAsync

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

    • getEnumDictionaryEntriesNode

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

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

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

    • getEnumDictionaryEntriesNodeAsync

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

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

      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.

      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.
      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.
      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().
      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[]).
      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.

      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().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.