#include <gnuradio/uhd/usrp_sink.h>

Inheritance diagram for gr::uhd::usrp_sink:

Public Types
typedef boost::shared_ptr < usrp_sink >	sptr

Public Types inherited from gr::block
enum	{ WORK_CALLED_PRODUCE = -2, WORK_DONE = -1 }
	Magic return values from general_work. More...

enum	tag_propagation_policy_t { TPP_DONT = 0, TPP_ALL_TO_ALL = 1, TPP_ONE_TO_ONE = 2 }

Public Member Functions
virtual void	set_start_time (const ::uhd::time_spec_t &time)=0

virtual ::uhd::dict < std::string, std::string >	get_usrp_info (size_t chan=0)=0

virtual void	set_subdev_spec (const std::string &spec, size_t mboard=0)=0

virtual std::string	get_subdev_spec (size_t mboard=0)=0

virtual void	set_samp_rate (double rate)=0

virtual double	get_samp_rate (void)=0

virtual ::uhd::meta_range_t	get_samp_rates (void)=0

virtual ::uhd::tune_result_t	set_center_freq (const ::uhd::tune_request_t tune_request, size_t chan=0)=0

::uhd::tune_result_t	set_center_freq (double freq, size_t chan=0)

virtual double	get_center_freq (size_t chan=0)=0

virtual ::uhd::freq_range_t	get_freq_range (size_t chan=0)=0

virtual void	set_gain (double gain, size_t chan=0)=0

virtual void	set_gain (double gain, const std::string &name, size_t chan=0)=0

virtual double	get_gain (size_t chan=0)=0

virtual double	get_gain (const std::string &name, size_t chan=0)=0

virtual std::vector< std::string >	get_gain_names (size_t chan=0)=0

virtual ::uhd::gain_range_t	get_gain_range (size_t chan=0)=0

virtual ::uhd::gain_range_t	get_gain_range (const std::string &name, size_t chan=0)=0

virtual void	set_antenna (const std::string &ant, size_t chan=0)=0

virtual std::string	get_antenna (size_t chan=0)=0

virtual std::vector< std::string >	get_antennas (size_t chan=0)=0

virtual void	set_bandwidth (double bandwidth, size_t chan=0)=0

virtual double	get_bandwidth (size_t chan=0)=0

virtual ::uhd::freq_range_t	get_bandwidth_range (size_t chan=0)=0

virtual void	set_dc_offset (const std::complex< double > &offset, size_t chan=0)=0

virtual void	set_iq_balance (const std::complex< double > &correction, size_t chan=0)=0

virtual ::uhd::sensor_value_t	get_sensor (const std::string &name, size_t chan=0)=0

virtual std::vector< std::string >	get_sensor_names (size_t chan=0)=0

::uhd::sensor_value_t	get_dboard_sensor (const std::string &name, size_t chan=0)
	DEPRECATED use get_sensor. More...

std::vector< std::string >	get_dboard_sensor_names (size_t chan=0)
	DEPRECATED use get_sensor_names. More...

virtual ::uhd::sensor_value_t	get_mboard_sensor (const std::string &name, size_t mboard=0)=0

virtual std::vector< std::string >	get_mboard_sensor_names (size_t mboard=0)=0

virtual void	set_clock_config (const ::uhd::clock_config_t &clock_config, size_t mboard=0)=0

virtual void	set_time_source (const std::string &source, const size_t mboard=0)=0

virtual std::string	get_time_source (const size_t mboard)=0

virtual std::vector< std::string >	get_time_sources (const size_t mboard)=0

virtual void	set_clock_source (const std::string &source, const size_t mboard=0)=0

virtual std::string	get_clock_source (const size_t mboard)=0

virtual std::vector< std::string >	get_clock_sources (const size_t mboard)=0

virtual double	get_clock_rate (size_t mboard=0)=0

virtual void	set_clock_rate (double rate, size_t mboard=0)=0

virtual ::uhd::time_spec_t	get_time_now (size_t mboard=0)=0

virtual ::uhd::time_spec_t	get_time_last_pps (size_t mboard=0)=0

virtual void	set_time_now (const ::uhd::time_spec_t &time_spec, size_t mboard=0)=0

virtual void	set_time_next_pps (const ::uhd::time_spec_t &time_spec)=0

virtual void	set_time_unknown_pps (const ::uhd::time_spec_t &time_spec)=0

virtual void	set_command_time (const ::uhd::time_spec_t &time_spec, size_t mboard=0)=0

virtual void	clear_command_time (size_t mboard=0)=0

virtual ::uhd::usrp::dboard_iface::sptr	get_dboard_iface (size_t chan=0)=0

virtual ::uhd::usrp::multi_usrp::sptr	get_device (void)=0

virtual void	set_user_register (const uint8_t addr, const uint32_t data, size_t mboard=0)=0

Public Member Functions inherited from gr::sync_block
virtual int	work (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)=0
	just like gr::block::general_work, only this arranges to call consume_each for you More...

void	forecast (int noutput_items, gr_vector_int &ninput_items_required)
	Estimate input requirements given output request. More...

int	general_work (int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
	compute output items from input items More...

int	fixed_rate_ninput_to_noutput (int ninput)
	Given ninput samples, return number of output samples that will be produced. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. More...

int	fixed_rate_noutput_to_ninput (int noutput)
	Given noutput samples, return number of input samples required to produce noutput. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. More...

Public Member Functions inherited from gr::block
virtual	~block ()

unsigned	history () const

void	set_history (unsigned history)

void	declare_sample_delay (int which, unsigned delay)

void	declare_sample_delay (unsigned delay)

unsigned	sample_delay (int which) const

bool	fixed_rate () const
	Return true if this block has a fixed input to output rate. More...

virtual bool	start ()
	Called to enable drivers, etc for i/o devices. More...

virtual bool	stop ()
	Called to disable drivers, etc for i/o devices. More...

void	set_output_multiple (int multiple)
	Constrain the noutput_items argument passed to forecast and general_work. More...

int	output_multiple () const

bool	output_multiple_set () const

void	set_alignment (int multiple)
	Constrains buffers to work on a set item alignment (for SIMD) More...

int	alignment () const

void	set_unaligned (int na)

int	unaligned () const

void	set_is_unaligned (bool u)

bool	is_unaligned () const

void	consume (int which_input, int how_many_items)
	Tell the scheduler `how_many_items` of input stream `which_input` were consumed. More...

void	consume_each (int how_many_items)
	Tell the scheduler `how_many_items` were consumed on each input stream. More...

void	produce (int which_output, int how_many_items)
	Tell the scheduler `how_many_items` were produced on output stream `which_output`. More...

void	set_relative_rate (double relative_rate)
	Set the approximate output rate / input rate. More...

double	relative_rate () const
	return the approximate output rate / input rate More...

uint64_t	nitems_read (unsigned int which_input)
	Return the number of items read on input stream which_input. More...

uint64_t	nitems_written (unsigned int which_output)
	Return the number of items written on output stream which_output. More...

tag_propagation_policy_t	tag_propagation_policy ()
	Asks for the policy used by the scheduler to moved tags downstream. More...

void	set_tag_propagation_policy (tag_propagation_policy_t p)
	Set the policy by the scheduler to determine how tags are moved downstream. More...

int	min_noutput_items () const
	Return the minimum number of output items this block can produce during a call to work. More...

void	set_min_noutput_items (int m)
	Set the minimum number of output items this block can produce during a call to work. More...

int	max_noutput_items ()
	Return the maximum number of output items this block will handle during a call to work. More...

void	set_max_noutput_items (int m)
	Set the maximum number of output items this block will handle during a call to work. More...

void	unset_max_noutput_items ()
	Clear the switch for using the max_noutput_items value of this block. More...

bool	is_set_max_noutput_items ()
	Ask the block if the flag is or is not set to use the internal value of max_noutput_items during a call to work. More...

void	expand_minmax_buffer (int port)

long	max_output_buffer (size_t i)
	Returns max buffer size on output port `i`. More...

void	set_max_output_buffer (long max_output_buffer)
	Sets max buffer size on all output ports. More...

void	set_max_output_buffer (int port, long max_output_buffer)
	Sets max buffer size on output port `port`. More...

long	min_output_buffer (size_t i)
	Returns min buffer size on output port `i`. More...

void	set_min_output_buffer (long min_output_buffer)
	Sets min buffer size on all output ports. More...

void	set_min_output_buffer (int port, long min_output_buffer)
	Sets min buffer size on output port `port`. More...

float	pc_noutput_items ()
	Gets instantaneous noutput_items performance counter. More...

float	pc_noutput_items_avg ()
	Gets average noutput_items performance counter. More...

float	pc_noutput_items_var ()
	Gets variance of noutput_items performance counter. More...

float	pc_nproduced ()
	Gets instantaneous num items produced performance counter. More...

float	pc_nproduced_avg ()
	Gets average num items produced performance counter. More...

float	pc_nproduced_var ()
	Gets variance of num items produced performance counter. More...

float	pc_input_buffers_full (int which)
	Gets instantaneous fullness of `which` input buffer. More...

float	pc_input_buffers_full_avg (int which)
	Gets average fullness of `which` input buffer. More...

float	pc_input_buffers_full_var (int which)
	Gets variance of fullness of `which` input buffer. More...

std::vector< float >	pc_input_buffers_full ()
	Gets instantaneous fullness of all input buffers. More...

std::vector< float >	pc_input_buffers_full_avg ()
	Gets average fullness of all input buffers. More...

std::vector< float >	pc_input_buffers_full_var ()
	Gets variance of fullness of all input buffers. More...

float	pc_output_buffers_full (int which)
	Gets instantaneous fullness of `which` input buffer. More...

float	pc_output_buffers_full_avg (int which)
	Gets average fullness of `which` input buffer. More...

float	pc_output_buffers_full_var (int which)
	Gets variance of fullness of `which` input buffer. More...

std::vector< float >	pc_output_buffers_full ()
	Gets instantaneous fullness of all output buffers. More...

std::vector< float >	pc_output_buffers_full_avg ()
	Gets average fullness of all output buffers. More...

std::vector< float >	pc_output_buffers_full_var ()
	Gets variance of fullness of all output buffers. More...

float	pc_work_time ()
	Gets instantaneous clock cycles spent in work. More...

float	pc_work_time_avg ()
	Gets average clock cycles spent in work. More...

float	pc_work_time_var ()
	Gets average clock cycles spent in work. More...

float	pc_work_time_total ()
	Gets total clock cycles spent in work. More...

void	reset_perf_counters ()
	Resets the performance counters. More...

void	setup_pc_rpc ()
	Sets up export of perf. counters to ControlPort. Only called by the scheduler. More...

bool	is_pc_rpc_set ()
	Checks if this block is already exporting perf. counters to ControlPort. More...

void	no_pc_rpc ()
	If the block calls this in its constructor, it's perf. counters will not be exported. More...

void	set_processor_affinity (const std::vector< int > &mask)
	Set the thread's affinity to processor core `n`. More...

void	unset_processor_affinity ()
	Remove processor affinity to a specific core. More...

std::vector< int >	processor_affinity ()
	Get the current processor affinity. More...

int	active_thread_priority ()
	Get the current thread priority in use. More...

int	thread_priority ()
	Get the current thread priority stored. More...

int	set_thread_priority (int priority)
	Set the current thread priority. More...

bool	update_rate () const

block_detail_sptr	detail () const

void	set_detail (block_detail_sptr detail)

Public Member Functions inherited from gr::basic_block
pmt::pmt_t	message_subscribers (pmt::pmt_t port)

virtual	~basic_block ()

long	unique_id () const

long	symbolic_id () const

std::string	name () const

std::string	symbol_name () const

gr::io_signature::sptr	input_signature () const

gr::io_signature::sptr	output_signature () const

basic_block_sptr	to_basic_block ()

bool	alias_set ()

std::string	alias ()

pmt::pmt_t	alias_pmt ()

void	set_block_alias (std::string name)

void	message_port_register_in (pmt::pmt_t port_id)

void	message_port_register_out (pmt::pmt_t port_id)

void	message_port_pub (pmt::pmt_t port_id, pmt::pmt_t msg)

void	message_port_sub (pmt::pmt_t port_id, pmt::pmt_t target)

void	message_port_unsub (pmt::pmt_t port_id, pmt::pmt_t target)

virtual bool	message_port_is_hier (pmt::pmt_t port_id)

virtual bool	message_port_is_hier_in (pmt::pmt_t port_id)

virtual bool	message_port_is_hier_out (pmt::pmt_t port_id)

pmt::pmt_t	message_ports_in ()
	Get input message port names. More...

pmt::pmt_t	message_ports_out ()
	Get output message port names. More...

void	_post (pmt::pmt_t which_port, pmt::pmt_t msg)

bool	empty_p (pmt::pmt_t which_port)
	is the queue empty? More...

bool	empty_p ()

bool	empty_handled_p (pmt::pmt_t which_port)
	are all msg ports with handlers empty? More...

bool	empty_handled_p ()

size_t	nmsgs (pmt::pmt_t which_port)
	How many messages in the queue? More...

void	insert_tail (pmt::pmt_t which_port, pmt::pmt_t msg)

pmt::pmt_t	delete_head_nowait (pmt::pmt_t which_port)

pmt::pmt_t	delete_head_blocking (pmt::pmt_t which_port)

msg_queue_t::iterator	get_iterator (pmt::pmt_t which_port)

void	erase_msg (pmt::pmt_t which_port, msg_queue_t::iterator it)

virtual bool	has_msg_port (pmt::pmt_t which_port)

virtual void	setup_rpc ()
	Set up the RPC registered variables. More...

bool	is_rpc_set ()
	Ask if this block has been registered to the RPC. More...

void	rpc_set ()
	When the block is registered with the RPC, set this. More...

virtual bool	check_topology (int ninputs, int noutputs)
	Confirm that ninputs and noutputs is an acceptable combination. More...

template<typename T >
void	set_msg_handler (pmt::pmt_t which_port, T msg_handler)
	Set the callback that is fired when messages are available. More...

Public Member Functions inherited from gr::msg_accepter
	msg_accepter ()

	~msg_accepter ()

void	post (pmt::pmt_t which_port, pmt::pmt_t msg)
	send `msg` to `msg_accepter` on port `which_port` More...

Public Member Functions inherited from gr::messages::msg_accepter
	msg_accepter ()

Static Public Member Functions
static sptr	make (const ::uhd::device_addr_t &device_addr, const ::uhd::io_type_t &io_type, size_t num_channels)
	Make a new USRP sink block.The USRP sink block reads a stream and transmits the samples. The sink block also provides API calls for transmitter settings. More...

static sptr	make (const ::uhd::device_addr_t &device_addr, const ::uhd::stream_args_t &stream_args)
	Make a new USRP sink block. More...

Additional Inherited Members
Protected Types inherited from gr::basic_block
enum	vcolor { WHITE, GREY, BLACK }

Protected Member Functions inherited from gr::sync_block
	sync_block (void)

	sync_block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature)

Protected Member Functions inherited from gr::block
	block (void)

	block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature)

void	set_fixed_rate (bool fixed_rate)

void	add_item_tag (unsigned int which_output, uint64_t abs_offset, const pmt::pmt_t &key, const pmt::pmt_t &value, const pmt::pmt_t &srcid=pmt::PMT_F)
	Adds a new tag onto the given output buffer. More...

void	add_item_tag (unsigned int which_output, const tag_t &tag)
	Adds a new tag onto the given output buffer. More...

void	remove_item_tag (unsigned int which_input, uint64_t abs_offset, const pmt::pmt_t &key, const pmt::pmt_t &value, const pmt::pmt_t &srcid=pmt::PMT_F)
	Removes a tag from the given input buffer. More...

void	remove_item_tag (unsigned int which_input, const tag_t &tag)
	Removes a tag from the given input buffer. More...

void	get_tags_in_range (std::vector< tag_t > &v, unsigned int which_input, uint64_t abs_start, uint64_t abs_end)
	Given a [start,end), returns a vector of all tags in the range. More...

void	get_tags_in_range (std::vector< tag_t > &v, unsigned int which_input, uint64_t abs_start, uint64_t abs_end, const pmt::pmt_t &key)
	Given a [start,end), returns a vector of all tags in the range with a given key. More...

void	get_tags_in_window (std::vector< tag_t > &v, unsigned int which_input, uint64_t rel_start, uint64_t rel_end)
	Gets all tags within the relative window of the current call to work. More...

void	get_tags_in_window (std::vector< tag_t > &v, unsigned int which_input, uint64_t rel_start, uint64_t rel_end, const pmt::pmt_t &key)
	Operates like gr::block::get_tags_in_window with the ability to only return tags with the specified `key`. More...

void	enable_update_rate (bool en)

Protected Member Functions inherited from gr::basic_block
	basic_block (void)

	basic_block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature)
	Protected constructor prevents instantiation by non-derived classes. More...

void	set_input_signature (gr::io_signature::sptr iosig)
	may only be called during constructor More...

void	set_output_signature (gr::io_signature::sptr iosig)
	may only be called during constructor More...

void	set_color (vcolor color)
	Allow the flowgraph to set for sorting and partitioning. More...

vcolor	color () const

virtual bool	has_msg_handler (pmt::pmt_t which_port)
	Tests if there is a handler attached to port `which_port`. More...

virtual void	dispatch_msg (pmt::pmt_t which_port, pmt::pmt_t msg)

Protected Attributes inherited from gr::block
std::vector< long >	d_max_output_buffer

std::vector< long >	d_min_output_buffer

gr::thread::mutex	d_setlock

gr::logger_ptr	d_logger

gr::logger_ptr	d_debug_logger

Protected Attributes inherited from gr::basic_block
std::string	d_name

gr::io_signature::sptr	d_input_signature

gr::io_signature::sptr	d_output_signature

long	d_unique_id

long	d_symbolic_id

std::string	d_symbol_name

std::string	d_symbol_alias

vcolor	d_color

bool	d_rpc_set

msg_queue_map_t	msg_queue

std::vector< boost::any >	d_rpc_vars

pmt::pmt_t	d_message_subscribers

Member Typedef Documentation

typedef boost::shared_ptr<usrp_sink> gr::uhd::usrp_sink::sptr

Member Function Documentation

virtual void gr::uhd::usrp_sink::clear_command_time ( size_t mboard = 0 )

pure virtual

Clear the command time so future commands are sent ASAP.

Parameters

mboard which motherboard to set the config

virtual std::string gr::uhd::usrp_sink::get_antenna ( size_t chan = 0 )

pure virtual

Get the antenna in use.

Parameters

chan	the channel index 0 to N-1

Returns: the antenna string

virtual std::vector<std::string> gr::uhd::usrp_sink::get_antennas ( size_t chan = 0 )

pure virtual

Get a list of possible antennas.

Parameters

chan	the channel index 0 to N-1

Returns: a vector of antenna strings

virtual double gr::uhd::usrp_sink::get_bandwidth ( size_t chan = 0 )

pure virtual

Get the bandpass filter setting on the RF frontend.

Parameters

chan	the channel index 0 to N-1

Returns: bandwidth of the filter in Hz

virtual ::uhd::freq_range_t gr::uhd::usrp_sink::get_bandwidth_range ( size_t chan = 0 )

pure virtual

Get the bandpass filter range of the RF frontend.

Parameters

chan	the channel index 0 to N-1

Returns: the range of the filter bandwidth in Hz

virtual double gr::uhd::usrp_sink::get_center_freq ( size_t chan = 0 )

pure virtual

Get the center frequency.

Parameters

chan	the channel index 0 to N-1

Returns: the frequency in Hz

virtual double gr::uhd::usrp_sink::get_clock_rate ( size_t mboard = 0 )

pure virtual

Get the master clock rate.

Parameters

mboard the motherboard index 0 to M-1

Returns: the clock rate in Hz

virtual std::string gr::uhd::usrp_sink::get_clock_source ( const size_t mboard )

pure virtual

Get the currently set clock source.

Parameters

mboard which motherboard to get the config

Returns: the string representing the clock source

virtual std::vector<std::string> gr::uhd::usrp_sink::get_clock_sources ( const size_t mboard )

pure virtual

Get a list of possible clock sources.

Parameters

mboard which motherboard to get the list

Returns: a vector of strings for possible settings

virtual ::uhd::usrp::dboard_iface::sptr gr::uhd::usrp_sink::get_dboard_iface ( size_t chan = 0 )

pure virtual

Get access to the underlying uhd dboard iface object.

Returns: the dboard_iface object

::uhd::sensor_value_t gr::uhd::usrp_sink::get_dboard_sensor	(	const std::string &	name,
		size_t	chan = `0`
	)

inline

DEPRECATED use get_sensor.

std::vector<std::string> gr::uhd::usrp_sink::get_dboard_sensor_names ( size_t chan = 0 )

inline

DEPRECATED use get_sensor_names.

virtual ::uhd::usrp::multi_usrp::sptr gr::uhd::usrp_sink::get_device ( void )

pure virtual

Get access to the underlying uhd device object.

Returns: the multi usrp device object

virtual ::uhd::freq_range_t gr::uhd::usrp_sink::get_freq_range ( size_t chan = 0 )

pure virtual

Get the tunable frequency range.

Parameters

chan	the channel index 0 to N-1

Returns: the frequency range in Hz

virtual double gr::uhd::usrp_sink::get_gain ( size_t chan = 0 )

pure virtual

Get the actual dboard gain setting.

Parameters

chan	the channel index 0 to N-1

Returns: the actual gain in dB

virtual double gr::uhd::usrp_sink::get_gain	(	const std::string &	name,
		size_t	chan = `0`
	)

pure virtual

Get the actual dboard gain setting of named stage.

Parameters

name	the name of the gain stage
chan	the channel index 0 to N-1

Returns: the actual gain in dB

virtual std::vector<std::string> gr::uhd::usrp_sink::get_gain_names ( size_t chan = 0 )

pure virtual

Get the actual dboard gain setting of named stage.

Parameters

chan	the channel index 0 to N-1

Returns: the actual gain in dB

virtual ::uhd::gain_range_t gr::uhd::usrp_sink::get_gain_range ( size_t chan = 0 )

pure virtual

Get the settable gain range.

Parameters

chan	the channel index 0 to N-1

Returns: the gain range in dB

virtual ::uhd::gain_range_t gr::uhd::usrp_sink::get_gain_range	(	const std::string &	name,
		size_t	chan = `0`
	)

pure virtual

Get the settable gain range.

Parameters

name	the name of the gain stage
chan	the channel index 0 to N-1

Returns: the gain range in dB

virtual ::uhd::sensor_value_t gr::uhd::usrp_sink::get_mboard_sensor	(	const std::string &	name,
		size_t	mboard = `0`
	)

pure virtual

Get a motherboard sensor value.

Parameters

name	the name of the sensor
mboard	the motherboard index 0 to M-1

Returns: a sensor value object

virtual std::vector<std::string> gr::uhd::usrp_sink::get_mboard_sensor_names ( size_t mboard = 0 )

pure virtual

Get a list of possible motherboard sensor names.

Parameters

mboard the motherboard index 0 to M-1

Returns: a vector of sensor names

virtual double gr::uhd::usrp_sink::get_samp_rate ( void )

pure virtual

Get the sample rate for the usrp device. This is the actual sample rate and may differ from the rate set.

Returns: the actual rate in Sps

virtual ::uhd::meta_range_t gr::uhd::usrp_sink::get_samp_rates ( void )

pure virtual

Get the possible sample rates for the usrp device.

Returns: a range of rates in Sps

virtual ::uhd::sensor_value_t gr::uhd::usrp_sink::get_sensor	(	const std::string &	name,
		size_t	chan = `0`
	)

pure virtual

Get an RF frontend sensor value.

Parameters

name	the name of the sensor
chan	the channel index 0 to N-1

Returns: a sensor value object

virtual std::vector<std::string> gr::uhd::usrp_sink::get_sensor_names ( size_t chan = 0 )

pure virtual

Get a list of possible RF frontend sensor names.

Parameters

chan	the channel index 0 to N-1

Returns: a vector of sensor names

virtual std::string gr::uhd::usrp_sink::get_subdev_spec ( size_t mboard = 0 )

pure virtual

Get the TX frontend specification.

Parameters

mboard the motherboard index 0 to M-1

Returns: the frontend specification in use

virtual ::uhd::time_spec_t gr::uhd::usrp_sink::get_time_last_pps ( size_t mboard = 0 )

pure virtual

Get the time when the last pps pulse occured.

Parameters

mboard the motherboard index 0 to M-1

Returns: the current usrp time

virtual ::uhd::time_spec_t gr::uhd::usrp_sink::get_time_now ( size_t mboard = 0 )

pure virtual

Get the current time registers.

Parameters

mboard the motherboard index 0 to M-1

Returns: the current usrp time

virtual std::string gr::uhd::usrp_sink::get_time_source ( const size_t mboard )

pure virtual

Get the currently set time source.

Parameters

mboard which motherboard to get the config

Returns: the string representing the time source

virtual std::vector<std::string> gr::uhd::usrp_sink::get_time_sources ( const size_t mboard )

pure virtual

Get a list of possible time sources.

Parameters

mboard which motherboard to get the list

Returns: a vector of strings for possible settings

virtual ::uhd::dict<std::string, std::string> gr::uhd::usrp_sink::get_usrp_info ( size_t chan = 0 )

pure virtual

Returns identifying information about this USRP's configuration. Returns motherboard ID, name, and serial. Returns daughterboard TX ID, subdev name and spec, serial, and antenna.

Parameters

chan	channel index 0 to N-1

Returns: TX info

static sptr gr::uhd::usrp_sink::make	(	const ::uhd::device_addr_t &	device_addr,
		const ::uhd::stream_args_t &	stream_args
	)

static

Make a new USRP sink block.

The USRP sink block reads a stream and transmits the samples. The sink block also provides API calls for transmitter settings.

TX Stream tagging:

The following tag keys will be consumed by the work function:

The sob and eob (start and end of burst) tag values are pmt booleans. When present, burst tags should be set to true (pmt::PMT_T).

The timstamp tag value is a pmt tuple of the following: (uint64 seconds, and double fractional seconds).

See the UHD manual for more detailed documentation: http://code.ettus.com/redmine/ettus/projects/uhd/wiki

Parameters

device_addr	the address to identify the hardware
stream_args	the IO format and channel specification

Returns: a new USRP sink block object

virtual void gr::uhd::usrp_sink::set_antenna	(	const std::string &	ant,
		size_t	chan = `0`
	)

pure virtual

Set the antenna to use.

Parameters

ant	the antenna string
chan	the channel index 0 to N-1

virtual void gr::uhd::usrp_sink::set_bandwidth	(	double	bandwidth,
		size_t	chan = `0`
	)

pure virtual

Set the bandpass filter on the RF frontend.

Parameters

chan	the channel index 0 to N-1
bandwidth	the filter bandwidth in Hz

virtual ::uhd::tune_result_t gr::uhd::usrp_sink::set_center_freq	(	const ::uhd::tune_request_t	tune_request,
		size_t	chan = `0`
	)

pure virtual

Tune the usrp device to the desired center frequency.

Parameters

tune_request	the tune request instructions
chan	the channel index 0 to N-1

Returns: a tune result with the actual frequencies

::uhd::tune_result_t gr::uhd::usrp_sink::set_center_freq	(	double	freq,
		size_t	chan = `0`
	)

inline

Tune the usrp device to the desired center frequency. This is a wrapper around set center freq so that in this case, the user can pass a single frequency in the call through swig.

Parameters

freq	the desired frequency in Hz
chan	the channel index 0 to N-1

Returns: a tune result with the actual frequencies

virtual void gr::uhd::usrp_sink::set_clock_config	(	const ::uhd::clock_config_t &	clock_config,
		size_t	mboard = `0`
	)

pure virtual

Set the clock configuration. DEPRECATED for set_time/clock_source.

Parameters

clock_config	the new configuration
mboard	the motherboard index 0 to M-1

virtual void gr::uhd::usrp_sink::set_clock_rate	(	double	rate,
		size_t	mboard = `0`
	)

pure virtual

Set the master clock rate.

Parameters

rate	the new rate in Hz
mboard	the motherboard index 0 to M-1

virtual void gr::uhd::usrp_sink::set_clock_source	(	const std::string &	source,
		const size_t	mboard = `0`
	)

pure virtual

Set the clock source for the usrp device. This sets the source for a 10 Mhz reference clock. Typical options for source: internal, external, MIMO.

Parameters

source	a string representing the clock source
mboard	which motherboard to set the config

virtual void gr::uhd::usrp_sink::set_command_time	(	const ::uhd::time_spec_t &	time_spec,
		size_t	mboard = `0`
	)

pure virtual

Set the time at which the control commands will take effect.

A timed command will back-pressure all subsequent timed commands, assuming that the subsequent commands occur within the time-window. If the time spec is late, the command will be activated upon arrival.

Parameters

time_spec	the time at which the next command will activate
mboard	which motherboard to set the config

virtual void gr::uhd::usrp_sink::set_dc_offset	(	const std::complex< double > &	offset,
		size_t	chan = `0`
	)

pure virtual

Set a constant DC offset value. The value is complex to control both I and Q.

Parameters

offset	the dc offset (1.0 is full-scale)
chan	the channel index 0 to N-1

virtual void gr::uhd::usrp_sink::set_gain	(	double	gain,
		size_t	chan = `0`
	)

pure virtual

Set the gain for the dboard.

Parameters

gain	the gain in dB
chan	the channel index 0 to N-1

virtual void gr::uhd::usrp_sink::set_gain	(	double	gain,
		const std::string &	name,
		size_t	chan = `0`
	)

pure virtual

Set the named gain on the dboard.

Parameters

gain	the gain in dB
name	the name of the gain stage
chan	the channel index 0 to N-1

virtual void gr::uhd::usrp_sink::set_iq_balance	(	const std::complex< double > &	correction,
		size_t	chan = `0`
	)

pure virtual

Set the RX frontend IQ imbalance correction. Use this to adjust the magnitude and phase of I and Q.

Parameters

correction	the complex correction (1.0 is full-scale)
chan	the channel index 0 to N-1

virtual void gr::uhd::usrp_sink::set_samp_rate ( double rate )

pure virtual

Set the sample rate for the usrp device.

Parameters

rate	a new rate in Sps

virtual void gr::uhd::usrp_sink::set_start_time ( const ::uhd::time_spec_t & time )

pure virtual

Set the start time for outgoing samples. To control when samples are transmitted, set this value before starting the flow graph. The value is cleared after each run. When not specified, the start time will be:

Immediately for the one channel case
in the near future for multi-channel

Parameters

time	the absolute time for transmission to begin

virtual void gr::uhd::usrp_sink::set_subdev_spec	(	const std::string &	spec,
		size_t	mboard = `0`
	)

pure virtual

Set the frontend specification.

Parameters

spec	the subdev spec markup string
mboard	the motherboard index 0 to M-1

virtual void gr::uhd::usrp_sink::set_time_next_pps ( const ::uhd::time_spec_t & time_spec )

pure virtual

Set the time registers at the next pps.

Parameters

time_spec the new time

virtual void gr::uhd::usrp_sink::set_time_now	(	const ::uhd::time_spec_t &	time_spec,
		size_t	mboard = `0`
	)

pure virtual

Sets the time registers immediately.

Parameters

time_spec	the new time
mboard	the motherboard index 0 to M-1

virtual void gr::uhd::usrp_sink::set_time_source	(	const std::string &	source,
		const size_t	mboard = `0`
	)

pure virtual

Set the time source for the usrp device. This sets the method of time synchronization, typically a pulse per second or an encoded time. Typical options for source: external, MIMO.

Parameters

source	a string representing the time source
mboard	which motherboard to set the config

virtual void gr::uhd::usrp_sink::set_time_unknown_pps ( const ::uhd::time_spec_t & time_spec )

pure virtual

Sync the time registers with an unknown pps edge.

Parameters

time_spec the new time

virtual void gr::uhd::usrp_sink::set_user_register	(	const uint8_t	addr,
		const uint32_t	data,
		size_t	mboard = `0`
	)

pure virtual

Perform write on the user configuration register bus. These only exist if the user has implemented custom setting registers in the device FPGA.

Parameters

addr	8-bit register address
data	32-bit register value
mboard	which motherboard to set the user register

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

usrp_sink.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Typedef Documentation

Member Function Documentation