#include <sink.h>

Inheritance diagram for gr::soapy::sink:

Public Types
typedef boost::shared_ptr< sink >	sptr

Public Member Functions
virtual void	set_gain (size_t channel, float gain)=0

virtual bool	DC_offset_support (int channel)=0

virtual bool	IQ_balance_support (int channel)=0

virtual bool	freq_correction_support (int channel)=0

virtual std::vector< std::string >	listAntennas (int channel)=0

virtual void	set_gain (size_t channel, const std::string name, float gain)=0

virtual void	set_frequency (size_t channel, double freq)=0

virtual void	set_frequency (size_t channel, const std::string &name, double frequency)=0

virtual void	set_gain_mode (size_t channel, bool gain_auto_mode)=0

virtual void	set_sample_rate (size_t channel, double sample_rate)=0

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

virtual void	set_antenna (size_t channel, const std::string &name)=0

virtual void	set_dc_offset (size_t channel, gr_complexd dc_offset, bool dc_offset_auto_mode)=0

virtual void	set_dc_offset_mode (size_t channel, bool dc_offset_auto_mode)=0

virtual void	set_frequency_correction (size_t channel, double freq_correction)=0

virtual void	set_iq_balance (size_t channel, gr_complexd iq_balance)=0

virtual void	set_master_clock_rate (double clock_rate)=0

virtual void	set_clock_source (const std::string &clock_source)=0

Static Public Member Functions
static sptr	make (size_t nchan, const std::string &device, const std::string &args, double sampling_rate, const std::string &type, const std::string &length_tag_name="")
	Return a shared_ptr to a new instance of soapy::sink. More...

Member Typedef Documentation

◆ sptr

typedef boost::shared_ptr<sink> gr::soapy::sink::sptr

Member Function Documentation

◆ DC_offset_support()

virtual bool gr::soapy::sink::DC_offset_support ( int channel )

pure virtual

Implemented in gr::soapy::sink_impl.

◆ freq_correction_support()

virtual bool gr::soapy::sink::freq_correction_support ( int channel )

pure virtual

Implemented in gr::soapy::sink_impl.

◆ IQ_balance_support()

virtual bool gr::soapy::sink::IQ_balance_support ( int channel )

pure virtual

Implemented in gr::soapy::sink_impl.

◆ listAntennas()

virtual std::vector<std::string> gr::soapy::sink::listAntennas ( int channel )

pure virtual

Implemented in gr::soapy::sink_impl.

◆ make()

static sptr gr::soapy::sink::make	(	size_t	nchan,
		const std::string &	device,
		const std::string &	args,
		double	sampling_rate,
		const std::string &	type,
		const std::string &	length_tag_name = `""`
	)

static

Return a shared_ptr to a new instance of soapy::sink.

To avoid accidental use of raw pointers, soapy::sink's constructor is in a private implementation class. soapy::sink::make is the public interface for creating new instances.

Parameters

nchan	number of channels
device	the device driver and type
args	the arguments passed to the device
sampling_rate	the sampling rate of the device
type	input stream format

Driver name can be any of "uhd", "lime", "airspy", "rtlsdr" or others

◆ set_antenna()

virtual void gr::soapy::sink::set_antenna	(	size_t	channel,
		const std::string &	name
	)

pure virtual

Callback to set antenna for RF chain

Parameters

channel	an available channel of the device
name	an available antenna string name

Implemented in gr::soapy::sink_impl.

◆ set_bandwidth()

virtual void gr::soapy::sink::set_bandwidth	(	size_t	channel,
		double	bandwidth
	)

pure virtual

Callback to set digital filter bandwidth

Parameters

channel	an available channel on the device
bandwidth	filter width in Hz

Implemented in gr::soapy::sink_impl.

◆ set_clock_source()

virtual void gr::soapy::sink::set_clock_source ( const std::string & clock_source )

pure virtual

Callback to set the clock source

Parameters

clock_source an available clock source

Implemented in gr::soapy::sink_impl.

◆ set_dc_offset()

virtual void gr::soapy::sink::set_dc_offset	(	size_t	channel,
		gr_complexd	dc_offset,
		bool	dc_offset_auto_mode
	)

pure virtual

Callback to set dc offset correction and mode

Parameters

channel	an available channel of the device
dc_offset	complex for dc offset correction
dc_offset_auto_mode	true if automatic dc offset correction

Implemented in gr::soapy::sink_impl.

◆ set_dc_offset_mode()

virtual void gr::soapy::sink::set_dc_offset_mode	(	size_t	channel,
		bool	dc_offset_auto_mode
	)

pure virtual

Callback to set automatic dc offset mode

Parameters

channel	an available channel of the device
dc_offset_auto_mode	true if automatic dc offset correction

Implemented in gr::soapy::sink_impl.

◆ set_frequency() [1/2]

virtual void gr::soapy::sink::set_frequency	(	size_t	channel,
		const std::string &	name,
		double	frequency
	)

pure virtual

Callback to change center frequency of a tunable element

Parameters

channel	an available channel of the device
name	an available element name
frequency	the frequency to be set in Hz

Implemented in gr::soapy::sink_impl.

◆ set_frequency() [2/2]

virtual void gr::soapy::sink::set_frequency	(	size_t	channel,
		double	freq
	)

pure virtual

Callback to change the RF frequency of the device

Parameters

channel	an available channel of the device
freq	the frequency to be set in Hz

Implemented in gr::soapy::sink_impl.

◆ set_frequency_correction()

virtual void gr::soapy::sink::set_frequency_correction	(	size_t	channel,
		double	freq_correction
	)

pure virtual

Callback to set frequency correction

Parameters

channel	an available channel of the device
freq_correction	relative value for frequency correction (1.0 max)

Implemented in gr::soapy::sink_impl.

◆ set_gain() [1/2]

virtual void gr::soapy::sink::set_gain	(	size_t	channel,
		const std::string	name,
		float	gain
	)

pure virtual

Callback to set specific gain value

Parameters

channel	an available channel on the device
name	the gain name to set value
gain	the gain value

Implemented in gr::soapy::sink_impl.

◆ set_gain() [2/2]

virtual void gr::soapy::sink::set_gain	(	size_t	channel,
		float	gain
	)

pure virtual

Callback to set overall gain

Parameters

channel	an available channel of the device
gain	the overall gain value

Implemented in gr::soapy::sink_impl.

◆ set_gain_mode()

virtual void gr::soapy::sink::set_gain_mode	(	size_t	channel,
		bool	gain_auto_mode
	)

pure virtual

Callback to set automatic gain mode

Parameters

channel	an available channel on the device
gain_auto_mode	true if automatic gain mode

Implemented in gr::soapy::sink_impl.

◆ set_iq_balance()

virtual void gr::soapy::sink::set_iq_balance	(	size_t	channel,
		gr_complexd	iq_balance
	)

pure virtual

Callback to set iq balance correction

Parameters

channel	an available channel of the device
iq_balance	complex value for iq balance correction

Implemented in gr::soapy::sink_impl.

◆ set_master_clock_rate()

virtual void gr::soapy::sink::set_master_clock_rate ( double clock_rate )

pure virtual

Callback to change master clock rate

Parameters

clock_rate the clock rate in Hz

Implemented in gr::soapy::sink_impl.

◆ set_sample_rate()

virtual void gr::soapy::sink::set_sample_rate	(	size_t	channel,
		double	sample_rate
	)

pure virtual

Callback to set sample rate

Parameters

channel	an available channel of the device
sample_rate	number of samples in samples per second

Implemented in gr::soapy::sink_impl.

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

sink.h

Public Types

Public Member Functions

Static Public Member Functions

Member Typedef Documentation

◆ sptr

Member Function Documentation

◆ DC_offset_support()

◆ freq_correction_support()

◆ IQ_balance_support()

◆ listAntennas()

◆ make()

◆ set_antenna()

◆ set_bandwidth()

◆ set_clock_source()

◆ set_dc_offset()

◆ set_dc_offset_mode()

◆ set_frequency() [1/2]

◆ set_frequency() [2/2]

◆ set_frequency_correction()

◆ set_gain() [1/2]

◆ set_gain() [2/2]

◆ set_gain_mode()

◆ set_iq_balance()

◆ set_master_clock_rate()

◆ set_sample_rate()