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

Interface DataTypeDescriptionType

All Superinterfaces:
BaseDataVariableType, BaseVariableType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode
All Known Implementing Classes:
DataTypeDescriptionTypeNode
public interface DataTypeDescriptionType extends BaseDataVariableType

  • Field Details

    • DATA_TYPE_VERSION

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String> DATA_TYPE_VERSION

    • DICTIONARY_FRAGMENT

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.ByteString> DICTIONARY_FRAGMENT

  • Method Details

    • getDataTypeVersion

      String getDataTypeVersion() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the DataTypeVersion Node.

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

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

    • setDataTypeVersion

      void setDataTypeVersion(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the DataTypeVersion Node.

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

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

    • readDataTypeVersion

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

    • writeDataTypeVersion

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

    • readDataTypeVersionAsync

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

    • writeDataTypeVersionAsync

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

    • getDataTypeVersionNode

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

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

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

    • getDataTypeVersionNodeAsync

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

    • getDictionaryFragment

      org.eclipse.milo.opcua.stack.core.types.builtin.ByteString getDictionaryFragment() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the DictionaryFragment Node.

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

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

    • setDictionaryFragment

      void setDictionaryFragment(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the DictionaryFragment Node.

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

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

    • readDictionaryFragment

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

    • writeDictionaryFragment

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

    • readDictionaryFragmentAsync

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

    • writeDictionaryFragmentAsync

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

    • getDictionaryFragmentNode

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

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

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

    • getDictionaryFragmentNodeAsync

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