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

Interface DataTypeDictionaryType

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

  • Field Details

    • DATA_TYPE_VERSION

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

    • NAMESPACE_URI

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

    • DEPRECATED

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

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

    • getNamespaceUri

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

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

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

    • setNamespaceUri

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

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

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

    • readNamespaceUri

      String readNamespaceUri() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the NamespaceUri 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.

    • writeNamespaceUri

      void writeNamespaceUri(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the NamespaceUri 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.

    • readNamespaceUriAsync

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

    • writeNamespaceUriAsync

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

    • getNamespaceUriNode

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

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

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

    • getNamespaceUriNodeAsync

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

    • getDeprecated

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

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

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

    • setDeprecated

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

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

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

    • readDeprecated

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

    • writeDeprecated

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

    • readDeprecatedAsync

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

    • writeDeprecatedAsync

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

    • getDeprecatedNode

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

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

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

    • getDeprecatedNodeAsync

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