summaryrefslogtreecommitdiff
path: root/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h
blob: 68e8b7ad9f285d979041626ac70de79c3c3dbeb3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
/* -*- c++ -*- */
/* Copyright 2012 Free Software Foundation, Inc.
 * 
 * This file is part of GNU Radio
 * 
 * GNU Radio is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3, or (at your option)
 * any later version.
 * 
 * GNU Radio is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with GNU Radio; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

#ifndef INCLUDED_OFDM_FRAME_EQUALIZER_VCVC_H
#define INCLUDED_OFDM_FRAME_EQUALIZER_VCVC_H

#include <digital/api.h>
#include <digital/ofdm_equalizer_base.h>
#include <gr_tagged_stream_block.h>

namespace gr {
  namespace digital {

    /*!
     * \brief OFDM frame equalizer
     * \ingroup ofdm
     *
     * Performs equalization in one or two dimensions on a tagged OFDM frame.
     * Input: a tagged series of OFDM symbols.
     * Output: The same as the input, but equalized.
     */
    class DIGITAL_API ofdm_frame_equalizer_vcvc : virtual public gr_tagged_stream_block
    {
     public:
      typedef boost::shared_ptr<ofdm_frame_equalizer_vcvc> sptr;

      /*
       * \param equalizer The equalizer object that will do the actual work
       * \param len_tag_key Length tag key
       * \param propagate_channel_state If true, the channel state after the last symbol
       *                                will be added to the first symbol as a tag
       */
      static sptr make(
	   ofdm_equalizer_base::sptr equalizer,
	   const std::string &len_tag_key = "frame_len",
	   bool propagate_channel_state=false
      );
    };

  } // namespace digital
} // namespace gr

#endif /* INCLUDED_OFDM_FRAME_EQUALIZER_VCVC_H */