GNU Radio Manual and C++ API Reference 3.7.14.0
The Free & Open Software Radio Ecosystem
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
27#include <gnuradio/msg_queue.h>
28#include <gnuradio/sync_block.h>
29
30namespace gr {
31namespace 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 * \ingroup deprecated_blk
39 *
40 * \details
41 * NOTE: The mod input parameter simply chooses a pre-defined
42 * demapper/slicer. Eventually, we want to be able to pass in a
43 * reference to an object to do the demapping and slicing for a
44 * given modulation type.
45 */
47{
48public:
49 // gr::digital::ofdm_frame_sink::sptr
50 typedef boost::shared_ptr<ofdm_frame_sink> sptr;
51
52 /*!
53 * Make an OFDM frame sink block.
54 *
55 * \param sym_position vector of OFDM carrier symbols in complex space
56 * \param sym_value_out vector of bit mapped from the complex symbol space
57 * \param target_queue message queue for the packets to go into
58 * \param occupied_tones The number of subcarriers with data in the received symbol
59 * \param phase_gain gain of the phase tracking loop
60 * \param freq_gain gain of the frequency tracking loop
61 */
62 static sptr make(const std::vector<gr_complex>& sym_position,
63 const std::vector<char>& sym_value_out,
64 msg_queue::sptr target_queue,
65 int occupied_tones,
66 float phase_gain = 0.25,
67 float freq_gain = 0.25 * 0.25 / 4);
68};
69
70} /* namespace digital */
71} /* namespace gr */
72
73#endif /* INCLUDED_GR_OFDM_FRAME_SINK_H */
Takes an OFDM symbol in, demaps it into bits of 0's and 1's, packs them into packets,...
Definition: ofdm_frame_sink.h:47
static sptr make(const std::vector< gr_complex > &sym_position, const std::vector< char > &sym_value_out, msg_queue::sptr target_queue, int occupied_tones, float phase_gain=0.25, float freq_gain=0.25 *0.25/4)
boost::shared_ptr< ofdm_frame_sink > sptr
Definition: ofdm_frame_sink.h:50
boost::shared_ptr< msg_queue > sptr
Definition: msg_queue.h:47
synchronous 1:1 input to output with history
Definition: sync_block.h:38
#define DIGITAL_API
Definition: gr-digital/include/gnuradio/digital/api.h:30
Include this header to use the message passing features.
Definition: basic_block.h:45