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

Interface AudioVariableType

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

  • Field Details

    • LIST_ID

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

    • AGENCY_ID

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

    • VERSION_ID

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

  • Method Details

    • getListId

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

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

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

    • setListId

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

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

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

    • readListId

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

    • writeListId

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

    • readListIdAsync

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

    • writeListIdAsync

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

    • getListIdNode

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

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

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

    • getListIdNodeAsync

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

    • getAgencyId

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

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

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

    • setAgencyId

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

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

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

    • readAgencyId

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

    • writeAgencyId

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

    • readAgencyIdAsync

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

    • writeAgencyIdAsync

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

    • getAgencyIdNode

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

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

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

    • getAgencyIdNodeAsync

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

    • getVersionId

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

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

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

    • setVersionId

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

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

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

    • readVersionId

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

    • writeVersionId

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

    • readVersionIdAsync

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

    • writeVersionIdAsync

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

    • getVersionIdNode

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

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

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

    • getVersionIdNodeAsync

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