Revision 91ace5a3 gr-uhd/include/gr_uhd_usrp_source.h

b/gr-uhd/include/gr_uhd_usrp_source.h
28 28

29 29
class uhd_usrp_source;
30 30

31
/*!
32
 * \brief Make a new USRP source block.
33
 *
34
 * The USRP source block receives samples and writes to a stream.
35
 * The source block also provides API calls for receiver settings.
36
 *
37
 * Stream tagging:
38
 *
39
 * The following tag keys will be produced by the work function:
40
 *  - pmt::pmt_string_to_symbol("rx_time")
41
 *
42
 * The timstamp tag value is a pmt tuple of the following:
43
 * (uint64 seconds, and double fractional seconds).
44
 * A timestamp tag is produced at start() and after overflows.
45
 *
46
 * See the UHD manual for more detailed documentation:
47
 * http://code.ettus.com/redmine/ettus/projects/uhd/wiki
48
 *
49
 * \param device_addr the address to identify the hardware
50
 * \param io_type the desired output data type
51
 * \param num_channels number of stream from the device
52
 * \return a new USRP source block object
53
 */
31 54
GR_UHD_API boost::shared_ptr<uhd_usrp_source> uhd_make_usrp_source(
32 55
    const uhd::device_addr_t &device_addr,
33 56
    const uhd::io_type_t &io_type,

Also available in: Unified diff