GNU Radio 3.5.1 C++ API
gr_sync_block.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004 Free Software Foundation, Inc.
00004  * 
00005  * This file is part of GNU Radio
00006  * 
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  * 
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  * 
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_GR_SYNC_BLOCK_H
00024 #define INCLUDED_GR_SYNC_BLOCK_H
00025 
00026 #include <gr_core_api.h>
00027 #include <gr_block.h>
00028 
00029 /*!
00030  * \brief synchronous 1:1 input to output with history
00031  * \ingroup base_blk
00032  *
00033  * Override work to provide the signal processing implementation.
00034  */
00035 class GR_CORE_API gr_sync_block : public gr_block
00036 {
00037  protected:
00038   gr_sync_block (void){} //allows pure virtual interface sub-classes
00039   gr_sync_block (const std::string &name,
00040                  gr_io_signature_sptr input_signature,
00041                  gr_io_signature_sptr output_signature);
00042 
00043  public:
00044 
00045   /*!
00046    * \brief just like gr_block::general_work, only this arranges to call consume_each for you
00047    *
00048    * The user must override work to define the signal processing code
00049    */
00050   virtual int work (int noutput_items,
00051                     gr_vector_const_void_star &input_items,
00052                     gr_vector_void_star &output_items) = 0;
00053   
00054 
00055   // gr_sync_block overrides these to assist work
00056   void forecast (int noutput_items, gr_vector_int &ninput_items_required);
00057   int  general_work (int noutput_items,
00058                      gr_vector_int &ninput_items,
00059                      gr_vector_const_void_star &input_items,
00060                      gr_vector_void_star &output_items);
00061 
00062   int fixed_rate_ninput_to_noutput(int ninput);
00063   int fixed_rate_noutput_to_ninput(int noutput);
00064 };
00065  
00066 #endif /* INCLUDED_GR_SYNC_BLOCK_H */