GNU Radio 3.6.1 C++ API
gr_sync_block Class Reference

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

#include <gr_sync_block.h>

Inherits gr_block.

Inherited by atsc_deinterleaver, atsc_derandomizer, atsc_ds_to_softds, atsc_equalizer, atsc_field_sync_mux, atsc_fpll, atsc_fs_checker, atsc_interleaver, atsc_randomizer, atsc_rs_decoder, atsc_rs_encoder, atsc_trellis_encoder, atsc_viterbi_decoder, audio_sink [virtual], audio_source [virtual], comedi_sink_s, comedi_source_s, digital_additive_scrambler_bb, digital_binary_slicer_fb, digital_correlate_access_code_bb, digital_correlate_access_code_tag_bb, digital_costas_loop_cc, digital_descrambler_bb, digital_diff_decoder_bb, digital_diff_encoder_bb, digital_diff_phasor_cc, digital_fll_band_edge_cc, digital_framer_sink_1, digital_glfsr_source_b, digital_glfsr_source_f, digital_map_bb, digital_mpsk_snr_est_cc, digital_ofdm_frame_sink, digital_ofdm_mapper_bcv, digital_packet_sink, digital_probe_density_b, digital_probe_mpsk_snr_est_c, digital_scrambler_bb, gr::fft::fft_vcc [virtual], gr::fft::fft_vfc [virtual], gr_add_ff, gr_additive_scrambler_bb, gr_agc2_cc, gr_agc2_ff, gr_agc_cc, gr_agc_ff, gr_annotator_1to1, gr_annotator_alltoall, gr_bin_statistics_f, gr_burst_tagger, gr_char_to_float, gr_char_to_short, gr_check_counting_s, gr_check_lfsr_32k_s, gr_complex_to_arg, gr_complex_to_float, gr_complex_to_imag, gr_complex_to_mag, gr_complex_to_mag_squared, gr_complex_to_real, gr_conjugate_cc, gr_correlate_access_code_tag_bb, gr_dc_blocker_cc, gr_dc_blocker_ff, gr_descrambler_bb, gr_diff_decoder_bb, gr_diff_encoder_bb, gr_diff_phasor_cc, gr_dpll_bb, gr_fake_channel_decoder_pp, gr_fake_channel_encoder_pp, gr_feedforward_agc_cc, gr_fft_vcc, gr_fft_vfc, gr_file_descriptor_sink, gr_file_descriptor_source, gr_file_sink, gr_file_source, gr_filter_delay_fc, gr_float_to_char, gr_float_to_complex, gr_float_to_int, gr_float_to_short, gr_float_to_uchar, gr_fmdet_cf, gr_framer_sink_1, gr_frequency_modulator_fc, gr_glfsr_source_b, gr_glfsr_source_f, gr_head, gr_hilbert_fc, gr_histo_sink_f, gr_iir_filter_ffd, gr_int_to_float, gr_iqcomp_cc, gr_kludge_copy, gr_lfsr_32k_source_s, gr_map_bb, gr_message_sink, gr_message_source, gr_multiply_cc, gr_multiply_conjugate_cc, gr_multiply_const_cc, gr_multiply_const_ff, gr_multiply_ff, gr_nlog10_ff, gr_null_sink, gr_null_source, gr_ofdm_frame_sink2, gr_oscope_sink_x, gr_pa_2x2_phase_combiner, gr_packet_sink, gr_peak_detector2_fb, gr_pfb_decimator_ccf, gr_phase_modulator_fc, gr_pll_carriertracking_cc, gr_pll_freqdet_cf, gr_pll_refout_cc, gr_probe_avg_mag_sqrd_c, gr_probe_avg_mag_sqrd_cf, gr_probe_avg_mag_sqrd_f, gr_probe_density_b, gr_quadrature_demod_cf, gr_rail_ff, gr_regenerate_bb, gr_rms_cf, gr_rms_ff, gr_scrambler_bb, gr_short_to_char, gr_short_to_float, gr_simple_squelch_cc, gr_single_pole_iir_filter_cc, gr_single_pole_iir_filter_ff, gr_streams_to_vector, gr_stretch_ff, gr_sync_decimator, gr_sync_interpolator, gr_tagged_file_sink, gr_threshold_ff, gr_throttle [virtual], gr_transcendental [virtual], gr_uchar_to_float, gr_udp_sink, gr_udp_source, gr_vco_f, gr_vector_map, gr_vector_to_streams, gr_wavfile_sink, gr_wavfile_source, noaa_hrpt_decoder, noaa_hrpt_pll_cf, pager_flex_parse, pager_slicer_fb, qtgui_time_sink_c, qtgui_time_sink_f, shd_smini_sink [virtual], shd_smini_source [virtual], tag_sink_demo, tag_source_demo, trellis_permutation, uhd_usrp_sink [virtual], uhd_usrp_source [virtual], video_sdl_sink_s, video_sdl_sink_uc, vocoder_alaw_decode_bs, vocoder_alaw_encode_sb, vocoder_g721_decode_bs [virtual], vocoder_g721_encode_sb [virtual], vocoder_g723_24_decode_bs [virtual], vocoder_g723_24_encode_sb [virtual], vocoder_g723_40_decode_bs [virtual], vocoder_g723_40_encode_sb [virtual], vocoder_ulaw_decode_bs, vocoder_ulaw_encode_sb, wavelet_squash_ff [virtual], wavelet_wavelet_ff [virtual], and wavelet_wvps_ff [virtual].

List of all members.

Public Member Functions

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.
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
std::string name () const
gr_io_signature_sptr input_signature () const
gr_io_signature_sptr output_signature () const
gr_basic_block_sptr to_basic_block ()
virtual bool check_topology (int ninputs, int noutputs)
 Confirm that ninputs and noutputs is an acceptable combination.
template<typename T >
void set_msg_handler (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 msg)
 send msg to msg_accepter
- Public Member Functions inherited from gruel::msg_accepter
 msg_accepter ()
virtual ~msg_accepter ()

Protected Member Functions

 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 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

Additional Inherited Members

- Public Types inherited from gr_block
enum  { WORK_CALLED_PRODUCE = -2, WORK_DONE = -1 }
 Magic return values from general_work. More...
enum  tag_propagation_policy_t { TPP_DONT = 0, TPP_ALL_TO_ALL = 1, TPP_ONE_TO_ONE = 2 }

Detailed Description

synchronous 1:1 input to output with history

Override work to provide the signal processing implementation.


Constructor & Destructor Documentation

gr_sync_block::gr_sync_block ( void  )
inlineprotected
gr_sync_block::gr_sync_block ( const std::string &  name,
gr_io_signature_sptr  input_signature,
gr_io_signature_sptr  output_signature 
)
protected

Member Function Documentation

int gr_sync_block::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_block.

Reimplemented in gr_sync_interpolator, and gr_sync_decimator.

int gr_sync_block::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_block.

Reimplemented in gr_sync_interpolator, and gr_sync_decimator.

void gr_sync_block::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_block.

Reimplemented in gr_sync_interpolator, gr_sync_decimator, atsc_equalizer, atsc_field_sync_mux, and atsc_pad.

int gr_sync_block::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.

Implements gr_block.

Reimplemented in gr_sync_interpolator, and gr_sync_decimator.

virtual int gr_sync_block::work ( int  noutput_items,
gr_vector_const_void_star input_items,
gr_vector_void_star output_items 
)
pure virtual

just like gr_block::general_work, only this arranges to call consume_each for you

The user must override work to define the signal processing code

Implemented in digital_fll_band_edge_cc, vocoder_cvsd_encode_sb, vocoder_cvsd_decode_bs, gr_complex_to_arg, gr_pfb_decimator_ccf, gr_pfb_synthesizer_ccf, gr_complex_to_mag_squared, gr_wavfile_sink, gr_pfb_interpolator_ccf, digital_ofdm_frame_sink, gr_complex_to_mag, digital_packet_sink, gr_ofdm_frame_sink2, digital_costas_loop_cc, gr_dc_blocker_ff, gr_udp_sink, gr_dc_blocker_cc, gr_udp_source, gr_framer_sink_1, gr_peak_detector2_fb, digital_framer_sink_1, gr_complex_to_imag, gr_packet_sink, qtgui_time_sink_c, gr_iir_filter_ffd, gr_bin_statistics_f, qtgui_time_sink_f, gr_check_lfsr_32k_s, digital_mpsk_snr_est_cc, digital_probe_mpsk_snr_est_c, gr_fake_channel_decoder_pp, video_sdl_sink_s, video_sdl_sink_uc, comedi_source_s, comedi_sink_s, gr_fft_filter_ccc, gr_fft_filter_fff, gr_single_pole_iir_filter_cc, gr_check_counting_s, audio_alsa_source, gr_single_pole_iir_filter_ff, gr_complex_to_real, digital_ofdm_mapper_bcv, audio_portaudio_sink, tag_source_demo, audio_alsa_sink, audio_osx_source, audio_portaudio_source, digital_correlate_access_code_tag_bb, gr_correlate_access_code_tag_bb, gr_vector_map, audio_jack_sink, audio_jack_source, digital_correlate_access_code_bb, gr_decode_ccsds_27_fb, gr_wavfile_source, noaa_hrpt_decoder, gr_regenerate_bb, gr_vco_f, digital_glfsr_source_b, digital_glfsr_source_f, digital_probe_density_b, gr_probe_density_b, audio_windows_sink, digital_additive_scrambler_bb, audio_osx_sink, gr_tagged_file_sink, gr_fft_vfc, digital_pn_correlator_cc, gr_char_to_float, gr_complex_to_float, gr_float_to_char, gr_float_to_int, gr_int_to_float, gr_short_to_float, gr_message_source, gr_additive_scrambler_bb, gr_float_to_short, gr_file_descriptor_source, gr_probe_avg_mag_sqrd_cf, gr_fft_vcc_fftw, gr_probe_avg_mag_sqrd_c, gr_probe_avg_mag_sqrd_f, gr_filter_delay_fc, gr_burst_tagger, gr_cpfsk_bc, gr_encode_ccsds_27_bb, gr_histo_sink_f, gr_glfsr_source_b, gr_glfsr_source_f, gr_pa_2x2_phase_combiner, gr_message_sink, gr_adaptive_fir_ccc, atsc_fpll, digital_bytes_to_syms, digital_descrambler_bb, digital_map_bb, digital_scrambler_bb, gr_bytes_to_syms, gr_file_source, trellis_permutation, gr_descrambler_bb, gr_lfsr_32k_source_s, gr_pn_correlator_cc, gr_scrambler_bb, gr_stretch_ff, gr_oscope_sink_f, gr_adaptive_fir_ccf, gr_annotator_alltoall, gr_fake_channel_encoder_pp, gr_frequency_modulator_fc, gr_multiply_const_cc, gr_multiply_const_ff, gr_threshold_ff, digital_diff_phasor_cc, gr_hilbert_fc, gr_annotator_1to1, gr_dpll_bb, gr_simple_squelch_cc, gr_file_descriptor_sink, gr_file_sink, wavelet_squash_ff_impl, gr_goertzel_fc, gr_char_to_short, gr_feedforward_agc_cc, gr_rail_ff, gr_repeat, gr_rms_cf, gr_rms_ff, gr_short_to_char, audio_oss_source, audio_windows_source, digital_diff_encoder_bb, gr::fft::fft_vcc_fftw, gr_agc2_cc, gr_kludge_copy, gr_multiply_conjugate_cc, gr_pack_k_bits_bb, gr_phase_modulator_fc, gr_quadrature_demod_cf, gr_stream_to_streams, gr_streams_to_stream, gr_unpack_k_bits_bb, atsc_randomizer, digital_diff_decoder_bb, digital_ofdm_cyclic_prefixer, gr::fft::fft_vfc_fftw, gr::fft::goertzel_fc_impl, vocoder_alaw_decode_bs, vocoder_ulaw_decode_bs, gr_add_ff, gr_agc_cc, gr_agc_ff, gr_iqcomp_cc, gr_multiply_cc, gr_multiply_ff, gr_nlog10_ff, atsc_equalizer, audio_oss_sink, pager_flex_deinterleave, pager_slicer_fb, vocoder_alaw_encode_sb, vocoder_ulaw_encode_sb, wavelet_wavelet_ff_impl, gr_agc2_ff, gr_deinterleave, gr_diff_encoder_bb, gr_float_to_complex, gr_head, gr_interleave, gr_stream_to_vector, gr_streams_to_vector, gr_vector_to_stream, gr_vector_to_streams, atsc_deinterleaver, atsc_derandomizer, atsc_fs_checker, atsc_rs_decoder, atsc_rs_encoder, atsc_trellis_encoder, atsc_viterbi_decoder, vocoder_gsm_fr_encode_sp, gr_diff_decoder_bb, gr_diff_phasor_cc, atsc_field_sync_mux, atsc_interleaver, atsc_pad, digital_binary_slicer_fb, gr_complex_to_interleaved_short, gr_conjugate_cc, gr_interleaved_short_to_complex, gr_map_bb, gr_null_sink, atsc_ds_to_softds, noaa_hrpt_pll_cf, vocoder_gsm_fr_decode_ps, gr_float_to_uchar, gr_null_source, gr_uchar_to_float, atsc_depad, vocoder_codec2_decode_ps, vocoder_codec2_encode_sp, tag_sink_demo, and wavelet_wvps_ff_impl.


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