[Commit-gnuradio] [gnuradio] 95/148: added documentation for handling of the expanded headers in the transmit calls

[git]

This is an automated email from the git hooks/post-receive script.

nwest pushed a commit to annotated tag old_usrp_devel_udp
in repository gnuradio.

commit b01b391b671f167cd764a707eaab5db661d6b76b
Author: Josh Blum <address@hidden>
Date:   Thu Dec 17 17:58:09 2009 -0800

    added documentation for handling of the expanded headers in the transmit 
calls
---
 usrp2/host/include/usrp2/usrp2.h | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/usrp2/host/include/usrp2/usrp2.h b/usrp2/host/include/usrp2/usrp2.h
index 1565002..949e457 100644
--- a/usrp2/host/include/usrp2/usrp2.h
+++ b/usrp2/host/include/usrp2/usrp2.h
@@ -286,6 +286,12 @@ namespace usrp2 {
      * The complex<float> samples are converted to the appropriate 
      * "on the wire" representation, depending on the current USRP2
      * configuration.  Typically, this is big-endian 16-bit I & Q.
+     *
+     * The underlying implementation is responsible for the packet count field,
+     * the packet size field, and fragmenting the samples into multiple 
packets.
+     * When the "start of burst flag" is set, only the first fragment will 
contain the start of burst.
+     * When the "end of burst flag" is set, only the last fragment will 
contain the end of burst.
+     * When the "has trailer flag" is set, every fragment will contain a copy 
of the trailer.
      */
     bool tx_32fc(
                 const std::complex<float> *samples,
@@ -302,6 +308,12 @@ namespace usrp2 {
      * The complex<int16_t> samples are converted to the appropriate
      * "on the wire" representation, depending on the current USRP2
      * configuration.  Typically, this is big-endian 16-bit I & Q.
+     *
+     * The underlying implementation is responsible for the packet count field,
+     * the packet size field, and fragmenting the samples into multiple 
packets.
+     * When the "start of burst flag" is set, only the first fragment will 
contain the start of burst.
+     * When the "end of burst flag" is set, only the last fragment will 
contain the end of burst.
+     * When the "has trailer flag" is set, every fragment will contain a copy 
of the trailer.
      */
     bool tx_16sc(
                 const std::complex<int16_t> *samples,
@@ -316,6 +328,12 @@ namespace usrp2 {
      * This method is used primarily by the system itself.  Users
      * should call tx_32fc or tx_16sc instead.
      *
+     * The underlying implementation is responsible for the packet count field,
+     * the packet size field, and fragmenting the samples into multiple 
packets.
+     * When the "start of burst flag" is set, only the first fragment will 
contain the start of burst.
+     * When the "end of burst flag" is set, only the last fragment will 
contain the end of burst.
+     * When the "has trailer flag" is set, every fragment will contain a copy 
of the trailer.
+     *
      * \param items are the data items to transmit
      * \param nitems is the number of items to transmit
      * \param hdr provides ids, times, flags