Updated license from GPL version 2 or later to GPL version 3 or later.
[debian/gnuradio] / gnuradio-core / src / lib / general / gr_ofdm_sampler.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2007 Free Software Foundation, Inc.
4  * 
5  * This file is part of GNU Radio
6  * 
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  * 
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #ifndef INCLUDED_GR_OFDM_SAMPLER_H
24 #define INCLUDED_GR_OFDM_SAMPLER_H
25
26 #include <gr_sync_block.h>
27
28 class gr_ofdm_sampler;
29 typedef boost::shared_ptr<gr_ofdm_sampler> gr_ofdm_sampler_sptr;
30
31 gr_ofdm_sampler_sptr gr_make_ofdm_sampler (unsigned int fft_length, 
32                                            unsigned int symbol_length);
33
34 /*!
35  * \brief does the rest of the OFDM stuff (fixme)
36  */
37
38 class gr_ofdm_sampler : public gr_block
39 {
40   friend gr_ofdm_sampler_sptr gr_make_ofdm_sampler (unsigned int fft_length, 
41                                                     unsigned int symbol_length);
42
43   gr_ofdm_sampler (unsigned int fft_length, 
44                    unsigned int symbol_length);
45
46  private:
47   unsigned int d_fft_length;
48   unsigned int d_symbol_length;
49
50  public:
51   void forecast (int noutput_items, gr_vector_int &ninput_items_required);
52
53   int general_work (int noutput_items,
54                     gr_vector_int &ninput_items,
55                     gr_vector_const_void_star &input_items,
56                     gr_vector_void_star &output_items);
57 };
58
59 #endif