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

Interface UadpWriterGroupMessageType

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

  • Field Details

    • GROUP_VERSION

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

    • DATA_SET_ORDERING

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.enumerated.DataSetOrderingType> DATA_SET_ORDERING

    • NETWORK_MESSAGE_CONTENT_MASK

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.structured.UadpNetworkMessageContentMask> NETWORK_MESSAGE_CONTENT_MASK

    • SAMPLING_OFFSET

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Double> SAMPLING_OFFSET

    • PUBLISHING_OFFSET

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Double[]> PUBLISHING_OFFSET

  • Method Details

    • getGroupVersion

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

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

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

    • setGroupVersion

      void setGroupVersion(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 GroupVersion Node.

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

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

    • readGroupVersion

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readGroupVersion() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the GroupVersion 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.

    • writeGroupVersion

      void writeGroupVersion(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 GroupVersion 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.

    • readGroupVersionAsync

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

    • writeGroupVersionAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeGroupVersionAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger value)
      An asynchronous implementation of writeGroupVersion(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.

    • getGroupVersionNode

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

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

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

    • getGroupVersionNodeAsync

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

    • getDataSetOrdering

      org.eclipse.milo.opcua.stack.core.types.enumerated.DataSetOrderingType getDataSetOrdering() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the DataSetOrdering Node.

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

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

    • setDataSetOrdering

      void setDataSetOrdering(org.eclipse.milo.opcua.stack.core.types.enumerated.DataSetOrderingType value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the DataSetOrdering Node.

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

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

    • readDataSetOrdering

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

    • writeDataSetOrdering

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

    • readDataSetOrderingAsync

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

    • writeDataSetOrderingAsync

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

    • getDataSetOrderingNode

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

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

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

    • getDataSetOrderingNodeAsync

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

    • getNetworkMessageContentMask

      org.eclipse.milo.opcua.stack.core.types.structured.UadpNetworkMessageContentMask getNetworkMessageContentMask() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the NetworkMessageContentMask Node.

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

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

    • setNetworkMessageContentMask

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

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

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

    • readNetworkMessageContentMask

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

    • writeNetworkMessageContentMask

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

    • readNetworkMessageContentMaskAsync

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

    • writeNetworkMessageContentMaskAsync

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

    • getNetworkMessageContentMaskNode

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

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

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

    • getNetworkMessageContentMaskNodeAsync

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

    • getSamplingOffset

      Double getSamplingOffset() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the SamplingOffset Node.

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

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

    • setSamplingOffset

      void setSamplingOffset(Double value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the SamplingOffset Node.

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

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

    • readSamplingOffset

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

    • writeSamplingOffset

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

    • readSamplingOffsetAsync

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

    • writeSamplingOffsetAsync

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

    • getSamplingOffsetNode

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

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

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

    • getSamplingOffsetNodeAsync

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

    • getPublishingOffset

      Double[] getPublishingOffset() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the PublishingOffset Node.

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

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

    • setPublishingOffset

      void setPublishingOffset(Double[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the PublishingOffset Node.

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

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

    • readPublishingOffset

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

    • writePublishingOffset

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

    • readPublishingOffsetAsync

      CompletableFuture<? extends Double[]> readPublishingOffsetAsync()
      An asynchronous implementation of readPublishingOffset().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writePublishingOffsetAsync

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

    • getPublishingOffsetNode

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

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

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

    • getPublishingOffsetNodeAsync

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