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

Interface DataSetWriterType

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

  • Field Details

    • DATA_SET_WRITER_ID

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort> DATA_SET_WRITER_ID

    • DATA_SET_FIELD_CONTENT_MASK

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.DataSetFieldContentMask> DATA_SET_FIELD_CONTENT_MASK

    • KEY_FRAME_COUNT

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> KEY_FRAME_COUNT

    • DATA_SET_WRITER_PROPERTIES

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[]> DATA_SET_WRITER_PROPERTIES

  • Method Details

    • getDataSetWriterId

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort getDataSetWriterId() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the DataSetWriterId Node.

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

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

    • setDataSetWriterId

      void setDataSetWriterId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the DataSetWriterId Node.

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

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

    • readDataSetWriterId

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

    • writeDataSetWriterId

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

    • readDataSetWriterIdAsync

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

    • writeDataSetWriterIdAsync

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

    • getDataSetWriterIdNode

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

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

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

    • getDataSetWriterIdNodeAsync

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

    • getDataSetFieldContentMask

      org.eclipse.milo.opcua.stack.core.types.structured.DataSetFieldContentMask getDataSetFieldContentMask() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the DataSetFieldContentMask Node.

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

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

    • setDataSetFieldContentMask

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

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

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

    • readDataSetFieldContentMask

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

    • writeDataSetFieldContentMask

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

    • readDataSetFieldContentMaskAsync

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

    • writeDataSetFieldContentMaskAsync

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

    • getDataSetFieldContentMaskNode

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

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

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

    • getDataSetFieldContentMaskNodeAsync

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

    • getKeyFrameCount

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getKeyFrameCount() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the KeyFrameCount Node.

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

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

    • setKeyFrameCount

      void setKeyFrameCount(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the KeyFrameCount Node.

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

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

    • readKeyFrameCount

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

    • writeKeyFrameCount

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

    • readKeyFrameCountAsync

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

    • writeKeyFrameCountAsync

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

    • getKeyFrameCountNode

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

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

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

    • getKeyFrameCountNodeAsync

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

    • getDataSetWriterProperties

      org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] getDataSetWriterProperties() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the DataSetWriterProperties Node.

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

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

    • setDataSetWriterProperties

      void setDataSetWriterProperties(org.eclipse.milo.opcua.stack.core.types.structured.KeyValuePair[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the DataSetWriterProperties Node.

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

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

    • readDataSetWriterProperties

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

    • writeDataSetWriterProperties

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

    • readDataSetWriterPropertiesAsync

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

    • writeDataSetWriterPropertiesAsync

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

    • getDataSetWriterPropertiesNode

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

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

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

    • getDataSetWriterPropertiesNodeAsync

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

    • getTransportSettingsNode

      DataSetWriterTransportType getTransportSettingsNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the TransportSettings DataSetWriterTransportType Node, or null if it does not exist.

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

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

    • getTransportSettingsNodeAsync

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

    • getMessageSettingsNode

      DataSetWriterMessageType getMessageSettingsNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the MessageSettings DataSetWriterMessageType Node, or null if it does not exist.

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

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

    • getMessageSettingsNodeAsync

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

    • getStatusNode

      PubSubStatusType getStatusNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the Status PubSubStatusType Node, or null if it does not exist.

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

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

    • getStatusNodeAsync

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

    • getDiagnosticsNode

      PubSubDiagnosticsDataSetWriterType getDiagnosticsNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the Diagnostics PubSubDiagnosticsDataSetWriterType Node, or null if it does not exist.

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

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

    • getDiagnosticsNodeAsync

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