GNU Radio's SOAPY Package
gr::soapy::sink Class Referenceabstract

#include <sink.h>

Inheritance diagram for gr::soapy::sink:
gr::soapy::sink_impl

Public Types

typedef boost::shared_ptr< sinksptr
 

Public Member Functions

virtual void set_gain (size_t channel, float gain)=0
 
virtual void set_overall_gain (size_t channel, float gain, bool manual_mode)=0
 
virtual bool hasDCOffset (int channel)=0
 
virtual bool hasIQBalance (int channel)=0
 
virtual bool hasFrequencyCorrection (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, bool manual_mode)=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

◆ hasDCOffset()

virtual bool gr::soapy::sink::hasDCOffset ( int  channel)
pure virtual

Implemented in gr::soapy::sink_impl.

◆ hasFrequencyCorrection()

virtual bool gr::soapy::sink::hasFrequencyCorrection ( int  channel)
pure virtual

Implemented in gr::soapy::sink_impl.

◆ hasIQBalance()

virtual bool gr::soapy::sink::hasIQBalance ( 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
nchannumber of channels
devicethe device driver and type
argsthe arguments passed to the device
sampling_ratethe sampling rate of the device
typeinput 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
channelan available channel of the device
namean 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
channelan available channel on the device
bandwidthfilter 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_sourcean 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
channelan available channel of the device
dc_offsetcomplex for dc offset correction
dc_offset_auto_modetrue 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
channelan available channel of the device
dc_offset_auto_modetrue 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
channelan available channel of the device
namean available element name
frequencythe 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
channelan available channel of the device
freqthe 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
channelan available channel of the device
freq_correctionrelative 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,
bool  manual_mode 
)
pure virtual

Callback to set specific gain value

Parameters
channelan available channel on the device
namethe gain name to set value
gainthe 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
channelan available channel of the device
gainthe 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
channelan available channel on the device
gain_auto_modetrue 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
channelan available channel of the device
iq_balancecomplex 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_ratethe clock rate in Hz

Implemented in gr::soapy::sink_impl.

◆ set_overall_gain()

virtual void gr::soapy::sink::set_overall_gain ( size_t  channel,
float  gain,
bool  manual_mode 
)
pure virtual

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
channelan available channel of the device
sample_ratenumber of samples in samples per second

Implemented in gr::soapy::sink_impl.


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