GNU Radio 3.5.3.2 C++ API
shd_smini_source Class Reference

#include <gr_shd_smini_source.h>

Inheritance diagram for shd_smini_source:

List of all members.

Public Member Functions

virtual void set_subdev_spec (const std::string &spec, size_t mboard=0)=0
virtual void set_samp_rate (double rate)=0
virtual double get_samp_rate (void)=0
virtual shd::tune_result_t set_center_freq (const shd::tune_request_t tune_request, size_t chan=0)=0
shd::tune_result_t set_center_freq (double freq, size_t chan=0)
virtual double get_center_freq (size_t chan=0)=0
virtual shd::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 shd::gain_range_t get_gain_range (size_t chan=0)=0
virtual shd::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 shd::sensor_value_t get_dboard_sensor (const std::string &name, size_t chan=0)=0
virtual std::vector< std::string > get_dboard_sensor_names (size_t chan=0)=0
virtual shd::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 shd::clock_config_t &clock_config, size_t mboard=0)=0
virtual double get_clock_rate (size_t mboard=0)=0
virtual void set_clock_rate (double rate, size_t mboard=0)=0
virtual shd::time_spec_t get_time_now (size_t mboard=0)=0
virtual shd::time_spec_t get_time_last_pps (size_t mboard=0)=0
virtual void set_time_now (const shd::time_spec_t &time_spec, size_t mboard=0)=0
virtual void set_time_next_pps (const shd::time_spec_t &time_spec)=0
virtual void set_time_unknown_pps (const shd::time_spec_t &time_spec)=0
virtual
shd::xmini::dboard_iface::sptr 
get_dboard_iface (size_t chan=0)=0
virtual
shd::xmini::multi_xmini::sptr 
get_device (void)=0

Member Function Documentation

virtual std::string shd_smini_source::get_antenna ( size_t  chan = 0) [pure virtual]

Get the antenna in use.

Parameters:
chanthe channel index 0 to N-1
Returns:
the antenna string
virtual std::vector<std::string> shd_smini_source::get_antennas ( size_t  chan = 0) [pure virtual]

Get a list of possible antennas.

Parameters:
chanthe channel index 0 to N-1
Returns:
a vector of antenna strings
virtual double shd_smini_source::get_center_freq ( size_t  chan = 0) [pure virtual]

Get the center frequency.

Parameters:
chanthe channel index 0 to N-1
Returns:
the frequency in Hz
virtual double shd_smini_source::get_clock_rate ( size_t  mboard = 0) [pure virtual]

Get the master clock rate.

Parameters:
mboardthe motherboard index 0 to M-1
Returns:
the clock rate in Hz
virtual shd::xmini::dboard_iface::sptr shd_smini_source::get_dboard_iface ( size_t  chan = 0) [pure virtual]

Get access to the underlying shd dboard iface object.

Returns:
the dboard_iface object
virtual shd::sensor_value_t shd_smini_source::get_dboard_sensor ( const std::string &  name,
size_t  chan = 0 
) [pure virtual]

Get a daughterboard sensor value.

Parameters:
namethe name of the sensor
chanthe channel index 0 to N-1
Returns:
a sensor value object
virtual std::vector<std::string> shd_smini_source::get_dboard_sensor_names ( size_t  chan = 0) [pure virtual]

Get a list of possible daughterboard sensor names.

Parameters:
chanthe channel index 0 to N-1
Returns:
a vector of sensor names
virtual shd::xmini::multi_xmini::sptr shd_smini_source::get_device ( void  ) [pure virtual]

Get access to the underlying shd device object.

Returns:
the multi smini device object
virtual shd::freq_range_t shd_smini_source::get_freq_range ( size_t  chan = 0) [pure virtual]

Get the tunable frequency range.

Parameters:
chanthe channel index 0 to N-1
Returns:
the frequency range in Hz
virtual double shd_smini_source::get_gain ( size_t  chan = 0) [pure virtual]

Get the actual dboard gain setting.

Parameters:
chanthe channel index 0 to N-1
Returns:
the actual gain in dB
virtual double shd_smini_source::get_gain ( const std::string &  name,
size_t  chan = 0 
) [pure virtual]

Get the actual dboard gain setting of named stage.

Parameters:
namethe name of the gain stage
chanthe channel index 0 to N-1
Returns:
the actual gain in dB
virtual std::vector<std::string> shd_smini_source::get_gain_names ( size_t  chan = 0) [pure virtual]

Get the actual dboard gain setting of named stage.

Parameters:
chanthe channel index 0 to N-1
Returns:
the actual gain in dB
virtual shd::gain_range_t shd_smini_source::get_gain_range ( size_t  chan = 0) [pure virtual]

Get the settable gain range.

Parameters:
chanthe channel index 0 to N-1
Returns:
the gain range in dB
virtual shd::gain_range_t shd_smini_source::get_gain_range ( const std::string &  name,
size_t  chan = 0 
) [pure virtual]

Get the settable gain range.

Parameters:
namethe name of the gain stage
chanthe channel index 0 to N-1
Returns:
the gain range in dB
virtual shd::sensor_value_t shd_smini_source::get_mboard_sensor ( const std::string &  name,
size_t  mboard = 0 
) [pure virtual]

Get a motherboard sensor value.

Parameters:
namethe name of the sensor
mboardthe motherboard index 0 to M-1
Returns:
a sensor value object
virtual std::vector<std::string> shd_smini_source::get_mboard_sensor_names ( size_t  mboard = 0) [pure virtual]

Get a list of possible motherboard sensor names.

Parameters:
mboardthe motherboard index 0 to M-1
Returns:
a vector of sensor names
virtual double shd_smini_source::get_samp_rate ( void  ) [pure virtual]

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

Returns:
the actual rate in Sps
virtual shd::time_spec_t shd_smini_source::get_time_last_pps ( size_t  mboard = 0) [pure virtual]

Get the time when the last pps pulse occured.

Parameters:
mboardthe motherboard index 0 to M-1
Returns:
the current smini time
virtual shd::time_spec_t shd_smini_source::get_time_now ( size_t  mboard = 0) [pure virtual]

Get the current time registers.

Parameters:
mboardthe motherboard index 0 to M-1
Returns:
the current smini time
virtual void shd_smini_source::set_antenna ( const std::string &  ant,
size_t  chan = 0 
) [pure virtual]

Set the antenna to use.

Parameters:
antthe antenna string
chanthe channel index 0 to N-1
virtual void shd_smini_source::set_bandwidth ( double  bandwidth,
size_t  chan = 0 
) [pure virtual]

Set the subdevice bandpass filter.

Parameters:
bandwidththe filter bandwidth in Hz
chanthe channel index 0 to N-1
shd::tune_result_t shd_smini_source::set_center_freq ( double  freq,
size_t  chan = 0 
) [inline]

Tune the smini 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:
freqthe desired frequency in Hz
chanthe channel index 0 to N-1
Returns:
a tune result with the actual frequencies
virtual shd::tune_result_t shd_smini_source::set_center_freq ( const shd::tune_request_t  tune_request,
size_t  chan = 0 
) [pure virtual]

Tune the smini device to the desired center frequency.

Parameters:
tune_requestthe tune request instructions
chanthe channel index 0 to N-1
Returns:
a tune result with the actual frequencies
virtual void shd_smini_source::set_clock_config ( const shd::clock_config_t &  clock_config,
size_t  mboard = 0 
) [pure virtual]

Set the clock configuration.

Parameters:
clock_configthe new configuration
mboardthe motherboard index 0 to M-1
virtual void shd_smini_source::set_clock_rate ( double  rate,
size_t  mboard = 0 
) [pure virtual]

Set the master clock rate.

Parameters:
ratethe new rate in Hz
mboardthe motherboard index 0 to M-1
virtual void shd_smini_source::set_gain ( double  gain,
const std::string &  name,
size_t  chan = 0 
) [pure virtual]

Set the named gain on the dboard.

Parameters:
gainthe gain in dB
namethe name of the gain stage
chanthe channel index 0 to N-1
virtual void shd_smini_source::set_gain ( double  gain,
size_t  chan = 0 
) [pure virtual]

Set the gain for the dboard.

Parameters:
gainthe gain in dB
chanthe channel index 0 to N-1
virtual void shd_smini_source::set_samp_rate ( double  rate) [pure virtual]

Set the sample rate for the smini device.

Parameters:
ratea new rate in Sps
virtual void shd_smini_source::set_subdev_spec ( const std::string &  spec,
size_t  mboard = 0 
) [pure virtual]

Set the subdevice specification.

Parameters:
specthe subdev spec markup string
mboardthe motherboard index 0 to M-1
virtual void shd_smini_source::set_time_next_pps ( const shd::time_spec_t &  time_spec) [pure virtual]

Set the time registers at the next pps.

Parameters:
time_specthe new time
virtual void shd_smini_source::set_time_now ( const shd::time_spec_t &  time_spec,
size_t  mboard = 0 
) [pure virtual]

Sets the time registers immediately.

Parameters:
time_specthe new time
mboardthe motherboard index 0 to M-1
virtual void shd_smini_source::set_time_unknown_pps ( const shd::time_spec_t &  time_spec) [pure virtual]

Sync the time registers with an unknown pps edge.

Parameters:
time_specthe new time

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