GNU Radio Manual and C++ API Reference  3.7.9.2
The Free & Open Software Radio Ecosystem
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
ofdm_frame_sink.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2007,2011,2012 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_DIGITAL_OFDM_FRAME_SINK_H
24 #define INCLUDED_DIGITAL_OFDM_FRAME_SINK_H
25 
26 #include <gnuradio/digital/api.h>
27 #include <gnuradio/sync_block.h>
28 #include <gnuradio/msg_queue.h>
29 
30 namespace gr {
31  namespace digital {
32 
33  /*!
34  * \brief Takes an OFDM symbol in, demaps it into bits of 0's and
35  * 1's, packs them into packets, and sends to to a message queue
36  * sink.
37  * \ingroup ofdm_blk
38  *
39  * \details
40  * NOTE: The mod input parameter simply chooses a pre-defined
41  * demapper/slicer. Eventually, we want to be able to pass in a
42  * reference to an object to do the demapping and slicing for a
43  * given modulation type.
44  */
45  class DIGITAL_API ofdm_frame_sink : virtual public sync_block
46  {
47  public:
48  // gr::digital::ofdm_frame_sink::sptr
49  typedef boost::shared_ptr<ofdm_frame_sink> sptr;
50 
51  /*!
52  * Make an OFDM frame sink block.
53  *
54  * \param sym_position vector of OFDM carrier symbols in complex space
55  * \param sym_value_out vector of bit mapped from the complex symbol space
56  * \param target_queue message queue for the packets to go into
57  * \param occupied_tones The number of subcarriers with data in the received symbol
58  * \param phase_gain gain of the phase tracking loop
59  * \param freq_gain gain of the frequency tracking loop
60  */
61  static sptr make(const std::vector<gr_complex> &sym_position,
62  const std::vector<char> &sym_value_out,
63  msg_queue::sptr target_queue,
64  int occupied_tones,
65  float phase_gain=0.25, float freq_gain=0.25*0.25/4);
66  };
67 
68  } /* namespace digital */
69 } /* namespace gr */
70 
71 #endif /* INCLUDED_GR_OFDM_FRAME_SINK_H */
boost::shared_ptr< msg_queue > sptr
Definition: msg_queue.h:47
#define DIGITAL_API
Definition: gr-digital/include/gnuradio/digital/api.h:30
Include this header to use the message passing features.
Definition: logger.h:131
synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_block.h:37
boost::shared_ptr< ofdm_frame_sink > sptr
Definition: ofdm_frame_sink.h:49
Takes an OFDM symbol in, demaps it into bits of 0's and 1's, packs them into packets, and sends to to a message queue sink.
Definition: ofdm_frame_sink.h:45