GNU Radio 3.6.4 C++ API
shd_smini_source Class Reference

#include <gr_shd_smini_source.h>

Inheritance diagram for shd_smini_source:
gr_sync_block gr_block gr_basic_block gr_msg_accepter gruel::msg_accepter

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
- 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
void forecast (int noutput_items, gr_vector_int &ninput_items_required)
 Estimate input requirements given output request.
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
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.
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.
- Public Member Functions inherited from gr_block
virtual ~gr_block ()
unsigned history () const
void set_history (unsigned history)
bool fixed_rate () const
 Return true if this block has a fixed input to output rate.
virtual bool start ()
 Called to enable drivers, etc for i/o devices.
virtual bool stop ()
 Called to disable drivers, etc for i/o devices.
void set_output_multiple (int multiple)
 Constrain the noutput_items argument passed to forecast and general_work.
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)
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.
void consume_each (int how_many_items)
 Tell the scheduler how_many_items were consumed on each input stream.
void produce (int which_output, int how_many_items)
 Tell the scheduler how_many_items were produced on output stream which_output.
void set_relative_rate (double relative_rate)
 Set the approximate output rate / input rate.
double relative_rate () const
 return the approximate output rate / input rate
uint64_t nitems_read (unsigned int which_input)
 Return the number of items read on input stream which_input.
uint64_t nitems_written (unsigned int which_output)
 Return the number of items written on output stream which_output.
tag_propagation_policy_t tag_propagation_policy ()
 Asks for the policy used by the scheduler to moved tags downstream.
void set_tag_propagation_policy (tag_propagation_policy_t p)
 Set the policy by the scheduler to determine how tags are moved downstream.
int min_noutput_items () const
 Return the minimum number of output items this block can produce during a call to work.
void set_min_noutput_items (int m)
 Set the minimum number of output items this block can produce during a call to work.
int max_noutput_items ()
 Return the maximum number of output items this block will handle during a call to work.
void set_max_noutput_items (int m)
 Set the maximum number of output items this block will handle during a call to work.
void unset_max_noutput_items ()
 Clear the switch for using the max_noutput_items value of this block.
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.
void expand_minmax_buffer (int port)
long max_output_buffer (size_t i)
 Returns max buffer size on output port i.
void set_max_output_buffer (long max_output_buffer)
 Sets max buffer size on all output ports.
void set_max_output_buffer (int port, long max_output_buffer)
 Sets max buffer size on output port port.
long min_output_buffer (size_t i)
 Returns min buffer size on output port i.
void set_min_output_buffer (long min_output_buffer)
 Sets min buffer size on all output ports.
void set_min_output_buffer (int port, long min_output_buffer)
 Sets min buffer size on output port port.
float pc_noutput_items ()
 Gets average noutput_items performance counter.
float pc_noutput_items_var ()
 Gets variance of noutput_items performance counter.
float pc_nproduced ()
 Gets average num items produced performance counter.
float pc_nproduced_var ()
 Gets variance of num items produced performance counter.
float pc_input_buffers_full (int which)
 Gets average fullness of which input buffer.
float pc_input_buffers_full_var (int which)
 Gets variance of fullness of which input buffer.
std::vector< float > pc_input_buffers_full ()
 Gets average fullness of all input buffers.
std::vector< float > pc_input_buffers_full_var ()
 Gets variance of fullness of all input buffers.
float pc_output_buffers_full (int which)
 Gets average fullness of which input buffer.
float pc_output_buffers_full_var (int which)
 Gets variance of fullness of which input buffer.
std::vector< float > pc_output_buffers_full ()
 Gets average fullness of all output buffers.
std::vector< float > pc_output_buffers_full_var ()
 Gets variance of fullness of all output buffers.
float pc_work_time ()
 Gets average clock cycles spent in work.
float pc_work_time_var ()
 Gets average clock cycles spent in work.
void reset_perf_counters ()
 Resets the performance counters.
void set_processor_affinity (const std::vector< unsigned int > &mask)
 Set the thread's affinity to processor core n.
void unset_processor_affinity ()
 Remove processor affinity to a specific core.
std::vector< unsigned int > processor_affinity ()
 Get the current processor affinity.
gr_block_detail_sptr detail () const
void set_detail (gr_block_detail_sptr detail)
- Public Member Functions inherited from gr_basic_block
virtual ~gr_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
gr_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.
pmt::pmt_t message_ports_out ()
 Get output message port names.
void _post (pmt::pmt_t which_port, pmt::pmt_t msg)
bool empty_p (pmt::pmt_t which_port)
 is the queue empty?
bool empty_p ()
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 bool check_topology (int ninputs, int noutputs)
 Confirm that ninputs and noutputs is an acceptable combination.
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.
- Public Member Functions inherited from gr_msg_accepter
 gr_msg_accepter ()
 ~gr_msg_accepter ()
void post (pmt::pmt_t which_port, pmt::pmt_t msg)
 send msg to msg_accepter on port which_port
- Public Member Functions inherited from gruel::msg_accepter
 msg_accepter ()
virtual ~msg_accepter ()

Additional Inherited Members

- Protected Member Functions inherited from gr_sync_block
 gr_sync_block (void)
 gr_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
 gr_block (void)
 gr_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.
void add_item_tag (unsigned int which_output, const gr_tag_t &tag)
 Adds a new tag onto the given output buffer.
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.
void remove_item_tag (unsigned int which_input, const gr_tag_t &tag)
 Removes a tag from the given input buffer.
void get_tags_in_range (std::vector< gr_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.
void get_tags_in_range (std::vector< gr_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.
- Protected Member Functions inherited from gr_basic_block
 gr_basic_block (void)
 gr_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.
void set_input_signature (gr_io_signature_sptr iosig)
 may only be called during constructor
void set_output_signature (gr_io_signature_sptr iosig)
 may only be called during constructor
void set_color (vcolor color)
 Allow the flowgraph to set for sorting and partitioning.
vcolor color () const
virtual void dispatch_msg (pmt::pmt_t which_port, pmt::pmt_t msg)

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
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
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 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,
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_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_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: