GNU Radio 3.7.3 C++ API
ofdm_cyclic_prefixer.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2013 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_CYCLIC_PREFIXER_H
24 #define INCLUDED_DIGITAL_OFDM_CYCLIC_PREFIXER_H
25 
26 #include <gnuradio/digital/api.h>
28 
29 namespace gr {
30  namespace digital {
31 
32  /*!
33  * \brief Adds a cyclic prefix and performs pulse shaping on OFDM symbols.
34  * \ingroup ofdm_blk
35  *
36  * \details
37  * Input: OFDM symbols (in the time domain, i.e. after the IFFT). Optionally,
38  * entire frames can be processed. In this case, \p len_tag_key must be
39  * specified which holds the key of the tag that denotes how
40  * many OFDM symbols are in a frame.
41  * Output: A stream of (scalar) complex symbols, which include the cyclic prefix
42  * and the pulse shaping.
43  * Note: If complete frames are processed, and \p rolloff_len is greater
44  * than zero, the final OFDM symbol is followed by the delay line of
45  * the pulse shaping.
46  *
47  * The pulse shape is a raised cosine in the time domain.
48  */
50  {
51  public:
53 
54  /*!
55  * \param input_size FFT length (i.e. length of the OFDM symbols)
56  * \param output_size FFT length + cyclic prefix length (in samples)
57  * \param rolloff_len Length of the rolloff flank in samples
58  * \param len_tag_key For framed processing the key of the length tag
59  */
60  static sptr make(
61  size_t input_size,
62  size_t output_size,
63  int rolloff_len=0,
64  const std::string &len_tag_key=""
65  );
66  };
67 
68  } // namespace digital
69 } // namespace gr
70 
71 #endif /* INCLUDED_DIGITAL_OFDM_CYCLIC_PREFIXER_H */
72 
Block that operates on PDUs in form of tagged streamsOverride work to provide the signal processing i...
Definition: tagged_stream_block.h:37
boost::shared_ptr< ofdm_cyclic_prefixer > sptr
Definition: ofdm_cyclic_prefixer.h:52
#define DIGITAL_API
Definition: gr-digital/include/gnuradio/digital/api.h:30
shared_ptr documentation stub
Definition: shared_ptr_docstub.h:15
Adds a cyclic prefix and performs pulse shaping on OFDM symbols.
Definition: ofdm_cyclic_prefixer.h:49