GNU Radio's OsmoSDR Package
osmosdr_source_c Class Referenceabstract

Provides a stream of complex samples.This uses the preferred technique: subclassing gr_hier_block2. More...

#include <osmosdr_source_c.h>

Inheritance diagram for osmosdr_source_c:

Public Types

enum  IQBalanceMode { IQBalanceOff = 0, IQBalanceManual, IQBalanceAutomatic }
 

Public Member Functions

virtual size_t get_num_channels (void)=0
 
virtual osmosdr::meta_range_t get_sample_rates (void)=0
 
virtual double set_sample_rate (double rate)=0
 
virtual double get_sample_rate (void)=0
 
virtual osmosdr::freq_range_t get_freq_range (size_t chan=0)=0
 
virtual double set_center_freq (double freq, size_t chan=0)=0
 
virtual double get_center_freq (size_t chan=0)=0
 
virtual double set_freq_corr (double ppm, size_t chan=0)=0
 
virtual double get_freq_corr (size_t chan=0)=0
 
virtual std::vector< std::string > get_gain_names (size_t chan=0)=0
 
virtual osmosdr::gain_range_t get_gain_range (size_t chan=0)=0
 
virtual osmosdr::gain_range_t get_gain_range (const std::string &name, size_t chan=0)=0
 
virtual bool set_gain_mode (bool automatic, size_t chan=0)=0
 
virtual bool get_gain_mode (size_t chan=0)=0
 
virtual double set_gain (double gain, size_t chan=0)=0
 
virtual double 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 double set_if_gain (double gain, size_t chan=0)=0
 
virtual std::vector< std::string > get_antennas (size_t chan=0)=0
 
virtual std::string set_antenna (const std::string &antenna, size_t chan=0)=0
 
virtual std::string get_antenna (size_t chan=0)=0
 
virtual void set_iq_balance_mode (int mode, size_t chan=0)=0
 
virtual void set_iq_balance (const std::complex< double > &correction, size_t chan=0)=0
 

Detailed Description

Provides a stream of complex samples.

This uses the preferred technique: subclassing gr_hier_block2.

Member Enumeration Documentation

Enumerator
IQBalanceOff 
IQBalanceManual 
IQBalanceAutomatic 

Member Function Documentation

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

Get the actual underlying radio hardware antenna setting.

Parameters
chanthe channel index 0 to N-1
Returns
antenna the actual antenna's name

Implemented in osmosdr_source_c_impl.

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

Get the available antennas of the underlying radio hardware.

Parameters
chanthe channel index 0 to N-1
Returns
a vector of strings containing the names of available antennas

Implemented in osmosdr_source_c_impl.

virtual double osmosdr_source_c::get_center_freq ( size_t  chan = 0)
pure virtual

Get the center frequency the underlying radio hardware is tuned to. This is the actual frequency and may differ from the frequency set.

Parameters
chanthe channel index 0 to N-1
Returns
the frequency in Hz

Implemented in osmosdr_source_c_impl.

virtual double osmosdr_source_c::get_freq_corr ( size_t  chan = 0)
pure virtual

Get the frequency correction value.

Parameters
chanthe channel index 0 to N-1
Returns
correction value in parts per million

Implemented in osmosdr_source_c_impl.

virtual osmosdr::freq_range_t osmosdr_source_c::get_freq_range ( size_t  chan = 0)
pure virtual

Get the tunable frequency range for the underlying radio hardware.

Parameters
chanthe channel index 0 to N-1
Returns
the frequency range in Hz

Implemented in osmosdr_source_c_impl.

virtual double osmosdr_source_c::get_gain ( size_t  chan = 0)
pure virtual

Get the actual gain setting of the underlying radio hardware.

Parameters
chanthe channel index 0 to N-1
Returns
the actual gain in dB

Implemented in osmosdr_source_c_impl.

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

Get the actual gain setting of a named stage.

Parameters
namethe name of the gain stage
chanthe channel index 0 to N-1
Returns
the actual gain in dB

Implemented in osmosdr_source_c_impl.

virtual bool osmosdr_source_c::get_gain_mode ( size_t  chan = 0)
pure virtual

Get the gain mode selected for the underlying radio hardware.

Parameters
chanthe channel index 0 to N-1
Returns
the actual gain mode (true means automatic gain mode)

Implemented in osmosdr_source_c_impl.

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

Get the gain stage names of the underlying radio hardware.

Parameters
chanthe channel index 0 to N-1
Returns
a vector of strings containing the names of gain stages

Implemented in osmosdr_source_c_impl.

virtual osmosdr::gain_range_t osmosdr_source_c::get_gain_range ( size_t  chan = 0)
pure virtual

Get the settable overall gain range for the underlying radio hardware.

Parameters
chanthe channel index 0 to N-1
Returns
the gain range in dB

Implemented in osmosdr_source_c_impl.

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

Get the settable gain range for a specific gain stage.

Parameters
namethe name of the gain stage
chanthe channel index 0 to N-1
Returns
the gain range in dB

Implemented in osmosdr_source_c_impl.

virtual size_t osmosdr_source_c::get_num_channels ( void  )
pure virtual

Get the number of channels the underlying radio hardware offers.

Returns
the number of available channels

Implemented in osmosdr_source_c_impl.

virtual double osmosdr_source_c::get_sample_rate ( void  )
pure virtual

Get the sample rate for the underlying radio hardware. This is the actual sample rate and may differ from the rate set.

Returns
the actual rate in Sps

Implemented in osmosdr_source_c_impl.

virtual osmosdr::meta_range_t osmosdr_source_c::get_sample_rates ( void  )
pure virtual

Get the possible sample rates for the underlying radio hardware.

Returns
a range of rates in Sps

Implemented in osmosdr_source_c_impl.

virtual std::string osmosdr_source_c::set_antenna ( const std::string &  antenna,
size_t  chan = 0 
)
pure virtual

Select the active antenna of the underlying radio hardware.

Parameters
antennaname of the antenna to be selected
chanthe channel index 0 to N-1
Returns
the actual antenna's name

Implemented in osmosdr_source_c_impl.

virtual double osmosdr_source_c::set_center_freq ( double  freq,
size_t  chan = 0 
)
pure virtual

Tune the underlying radio hardware to the desired center frequency. This also will select the appropriate RF bandpass.

Parameters
freqthe desired frequency in Hz
chanthe channel index 0 to N-1
Returns
the actual frequency in Hz

Implemented in osmosdr_source_c_impl.

virtual double osmosdr_source_c::set_freq_corr ( double  ppm,
size_t  chan = 0 
)
pure virtual

Set the frequency correction value in parts per million.

Parameters
ppmthe desired correction value in parts per million
chanthe channel index 0 to N-1
Returns
correction value in parts per million

Implemented in osmosdr_source_c_impl.

virtual double osmosdr_source_c::set_gain ( double  gain,
size_t  chan = 0 
)
pure virtual

Set the gain for the underlying radio hardware. This function will automatically distribute the desired gain value over available gain stages in an appropriate way and return the actual value.

Parameters
gainthe gain in dB
chanthe channel index 0 to N-1
Returns
the actual gain in dB

Implemented in osmosdr_source_c_impl.

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

Set the named gain on the underlying radio hardware.

Parameters
gainthe gain in dB
namethe name of the gain stage
chanthe channel index 0 to N-1
Returns
the actual gain in dB

Implemented in osmosdr_source_c_impl.

virtual bool osmosdr_source_c::set_gain_mode ( bool  automatic,
size_t  chan = 0 
)
pure virtual

Set the gain mode for the underlying radio hardware. This might be supported only for certain hardware types.

Parameters
automaticthe gain mode (true means automatic gain mode)
chanthe channel index 0 to N-1
Returns
the actual gain mode

Implemented in osmosdr_source_c_impl.

virtual double osmosdr_source_c::set_if_gain ( double  gain,
size_t  chan = 0 
)
pure virtual

Set the IF gain for the underlying radio hardware. This function will automatically distribute the desired gain value over available IF gain stages in an appropriate way and return the actual value.

Parameters
gainthe gain in dB
chanthe channel index 0 to N-1
Returns
the actual gain in dB

Implemented in osmosdr_source_c_impl.

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

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

Parameters
correctionthe complex correction value
chanthe channel index 0 to N-1

Implemented in osmosdr_source_c_impl.

virtual void osmosdr_source_c::set_iq_balance_mode ( int  mode,
size_t  chan = 0 
)
pure virtual

Set the RX frontend IQ balance mode.

Parameters
modeiq balance correction mode: 0 = Off, 1 = Manual, 2 = Automatic
chanthe channel index 0 to N-1

Implemented in osmosdr_source_c_impl.

virtual double osmosdr_source_c::set_sample_rate ( double  rate)
pure virtual

Set the sample rate for the underlying radio hardware. This also will select the appropriate IF bandpass, if applicable.

Parameters
ratea new rate in Sps

Implemented in osmosdr_source_c_impl.


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