GNU Radio 3.4.2 C++ API
usrp_source_s Class Reference

Interface to Universal Software Radio Peripheral Rx pathoutput: 1 stream of short. More...

#include <usrp_source_s.h>

Inheritance diagram for usrp_source_s:

List of all members.

Public Member Functions

 ~usrp_source_s ()

Protected Member Functions

 usrp_source_s (int which_board, unsigned int decim_rate, int nchan, int mux, int mode, int fusb_block_size, int fusb_nblocks, const std::string fpga_filename, const std::string firmware_filename) throw (std::runtime_error)
virtual int ninput_bytes_reqd_for_noutput_items (int noutput_items)
 return number of usrp input bytes required to produce noutput items.
virtual void copy_from_usrp_buffer (gr_vector_void_star &output_items, int output_index, int output_items_available, int &output_items_produced, const void *usrp_buffer, int usrp_buffer_length, int &bytes_read)
 convert between native usrp format and output item format

Friends

usrp_source_s_sptr usrp_make_source_s (int which_board, unsigned int decim_rate, int nchan, int mux, int mode, int fusb_block_size, int fusb_nblocks, const std::string fpga_filename, const std::string firmware_filename) throw (std::runtime_error)

Detailed Description

Interface to Universal Software Radio Peripheral Rx path

output: 1 stream of short.


Constructor & Destructor Documentation

usrp_source_s::usrp_source_s ( int  which_board,
unsigned int  decim_rate,
int  nchan,
int  mux,
int  mode,
int  fusb_block_size,
int  fusb_nblocks,
const std::string  fpga_filename,
const std::string  firmware_filename 
) throw (std::runtime_error) [protected]
usrp_source_s::~usrp_source_s ( )

Member Function Documentation

virtual void usrp_source_s::copy_from_usrp_buffer ( gr_vector_void_star output_items,
int  output_index,
int  output_items_available,
int &  output_items_produced,
const void *  usrp_buffer,
int  usrp_buffer_length,
int &  bytes_read 
) [protected, virtual]

convert between native usrp format and output item format

Parameters:
[out]output_itemsstream(s) of output items
[in]output_indexstarting index in output_items
[in]output_items_availablenumber of empty items available at item[index]
[out]output_items_producednumber of items produced by copy
[in]usrp_buffersource buffer
[in]usrp_buffer_lengthnumber of bytes available in usrp_buffer
[out]bytes_readnumber of bytes read from usrp_buffer

The copy must consume all bytes available. That is, bytes_read must equal usrp_buffer_length.

Implements usrp_source_base.

virtual int usrp_source_s::ninput_bytes_reqd_for_noutput_items ( int  noutput_items) [protected, virtual]

return number of usrp input bytes required to produce noutput items.

Implements usrp_source_base.


Friends And Related Function Documentation

usrp_source_s_sptr usrp_make_source_s ( int  which_board,
unsigned int  decim_rate,
int  nchan,
int  mux,
int  mode,
int  fusb_block_size,
int  fusb_nblocks,
const std::string  fpga_filename,
const std::string  firmware_filename 
) throw (std::runtime_error) [friend]

The documentation for this class was generated from the following file: