GNU Radio 3.6.5 C++ API

gr_sync_decimator Class Reference

synchronous N:1 input to output with historyOverride work to provide the signal processing implementation. More...

#include <gr_sync_decimator.h>

Inheritance diagram for gr_sync_decimator:
gr_sync_block gr_block gr_basic_block gr_msg_accepter gruel::msg_accepter atsc_pad digital_pn_correlator_cc gr::blocks::deinterleave gr::blocks::integrate_cc gr::blocks::integrate_ff gr::blocks::integrate_ii gr::blocks::integrate_ss gr::blocks::interleaved_short_to_complex gr::blocks::pack_k_bits_bb gr::blocks::stream_to_streams gr::blocks::stream_to_vector gr::fft::goertzel_fc gr::filter::adaptive_fir_ccc gr::filter::adaptive_fir_ccf gr::filter::fft_filter_ccc gr::filter::fft_filter_fff gr::filter::fir_filter_ccc gr::filter::fir_filter_ccf gr::filter::fir_filter_fcc gr::filter::fir_filter_fff gr::filter::fir_filter_fsf gr::filter::fir_filter_scc gr::filter::freq_xlating_fir_filter_ccc gr::filter::freq_xlating_fir_filter_ccf gr::filter::freq_xlating_fir_filter_fcc gr::filter::freq_xlating_fir_filter_fcf gr::filter::freq_xlating_fir_filter_scc gr::filter::freq_xlating_fir_filter_scf gr_adaptive_fir_ccc gr_adaptive_fir_ccf gr_decode_ccsds_27_fb gr_deinterleave gr_fft_filter_ccc gr_fft_filter_fff gr_fir_filter_ccc gr_fir_filter_ccf gr_fir_filter_fcc gr_fir_filter_fff gr_fir_filter_fsf gr_fir_filter_scc gr_freq_xlating_fir_filter_ccc gr_freq_xlating_fir_filter_ccf gr_freq_xlating_fir_filter_fcc gr_freq_xlating_fir_filter_fcf gr_freq_xlating_fir_filter_scc gr_freq_xlating_fir_filter_scf gr_goertzel_fc gr_integrate_cc gr_integrate_ff gr_integrate_ii gr_integrate_ss gr_interleaved_short_to_complex gr_pack_k_bits_bb gr_pn_correlator_cc gr_stream_to_streams gr_stream_to_vector pager_flex_deinterleave vocoder_codec2_encode_sp vocoder_cvsd_encode_sb vocoder_gsm_fr_encode_sp

List of all members.

Public Member Functions

unsigned decimation () const
void set_decimation (unsigned decimation)
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.

Protected Member Functions

 gr_sync_decimator (void)
 gr_sync_decimator (const std::string &name, gr_io_signature_sptr input_signature, gr_io_signature_sptr output_signature, unsigned decimation)

Detailed Description

synchronous N:1 input to output with history

Override work to provide the signal processing implementation.


Constructor & Destructor Documentation

gr_sync_decimator::gr_sync_decimator ( void  ) [inline, protected]
gr_sync_decimator::gr_sync_decimator ( const std::string &  name,
gr_io_signature_sptr  input_signature,
gr_io_signature_sptr  output_signature,
unsigned  decimation 
) [protected]

Member Function Documentation

unsigned gr_sync_decimator::decimation ( ) const [inline]
int gr_sync_decimator::fixed_rate_ninput_to_noutput ( int  ninput) [virtual]

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.

Reimplemented from gr_sync_block.

int gr_sync_decimator::fixed_rate_noutput_to_ninput ( int  noutput) [virtual]

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.

Reimplemented from gr_sync_block.

void gr_sync_decimator::forecast ( int  noutput_items,
gr_vector_int ninput_items_required 
) [virtual]

Estimate input requirements given output request.

Parameters:
noutput_itemsnumber of output items to produce
ninput_items_requirednumber of input items required on each input stream

Given a request to product noutput_items, estimate the number of data items required on each input stream. The estimate doesn't have to be exact, but should be close.

Reimplemented from gr_sync_block.

Reimplemented in atsc_pad.

int gr_sync_decimator::general_work ( int  noutput_items,
gr_vector_int ninput_items,
gr_vector_const_void_star input_items,
gr_vector_void_star output_items 
) [virtual]

compute output items from input items

Parameters:
noutput_itemsnumber of output items to write on each output stream
ninput_itemsnumber of input items available on each input stream
input_itemsvector of pointers to the input items, one entry per input stream
output_itemsvector of pointers to the output items, one entry per output stream
Returns:
number of items actually written to each output stream, or -1 on EOF. It is OK to return a value less than noutput_items. -1 <= return value <= noutput_items

general_work must call consume or consume_each to indicate how many items were consumed on each input stream.

Reimplemented from gr_sync_block.

void gr_sync_decimator::set_decimation ( unsigned  decimation) [inline]

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