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

Interface StandaloneSubscribedDataSetType

All Superinterfaces:
BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Implementing Classes:
StandaloneSubscribedDataSetTypeNode
public interface StandaloneSubscribedDataSetType extends BaseObjectType
See Also:

  • Field Details

    • DATA_SET_META_DATA

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType> DATA_SET_META_DATA

    • IS_CONNECTED

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

  • Method Details

    • getDataSetMetaData

      org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType getDataSetMetaData() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the DataSetMetaData Node.

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

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

    • setDataSetMetaData

      void setDataSetMetaData(org.eclipse.milo.opcua.stack.core.types.structured.DataSetMetaDataType value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the DataSetMetaData Node.

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

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

    • readDataSetMetaData

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

    • writeDataSetMetaData

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

    • readDataSetMetaDataAsync

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

    • writeDataSetMetaDataAsync

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

    • getDataSetMetaDataNode

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

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

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

    • getDataSetMetaDataNodeAsync

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

    • getIsConnected

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

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

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

    • setIsConnected

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

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

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

    • readIsConnected

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

    • writeIsConnected

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

    • readIsConnectedAsync

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

    • writeIsConnectedAsync

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

    • getIsConnectedNode

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

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

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

    • getIsConnectedNodeAsync

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

    • getSubscribedDataSetNode

      SubscribedDataSetType getSubscribedDataSetNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the SubscribedDataSet SubscribedDataSetType Node, or null if it does not exist.

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

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

    • getSubscribedDataSetNodeAsync

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