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_insert_preamble.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 along
18  * with this program; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20  */
21 
22 #ifndef INCLUDED_DIGITAL_OFDM_INSERT_PREAMBLE_H
23 #define INCLUDED_DIGITAL_OFDM_INSERT_PREAMBLE_H
24 
25 #include <gnuradio/digital/api.h>
26 #include <gnuradio/block.h>
27 #include <vector>
28 
29 namespace gr {
30  namespace digital {
31 
32  /*!
33  * \brief insert "pre-modulated" preamble symbols before each payload.
34  * \ingroup ofdm_blk
35  * \ingroup synchronizers_blk
36  *
37  * \details
38  * <pre>
39  * input 1: stream of vectors of gr_complex [fft_length]
40  * These are the modulated symbols of the payload.
41  *
42  * input 2: stream of char. The LSB indicates whether the corresponding
43  * symbol on input 1 is the first symbol of the payload or not.
44  * It's a 1 if the corresponding symbol is the first symbol,
45  * otherwise 0.
46  *
47  * N.B., this implies that there must be at least 1 symbol in the payload.
48  *
49  * output 1: stream of vectors of gr_complex [fft_length]
50  * These include the preamble symbols and the payload symbols.
51  *
52  * output 2: stream of char. The LSB indicates whether the corresponding
53  * symbol on input 1 is the first symbol of a packet (i.e., the
54  * first symbol of the preamble.) It's a 1 if the corresponding
55  * symbol is the first symbol, otherwise 0.
56  * </pre>
57  */
58  class DIGITAL_API ofdm_insert_preamble : virtual public block
59  {
60  public:
61  // gr::digital::ofdm_insert_preamble::sptr
62  typedef boost::shared_ptr<ofdm_insert_preamble> sptr;
63 
64  /*!
65  * Make an OFDM preamble inserter block.
66  *
67  * \param fft_length length of each symbol in samples.
68  * \param preamble vector of symbols that represent the pre-modulated preamble.
69  */
70  static sptr make(int fft_length,
71  const std::vector<std::vector<gr_complex> > &preamble);
72 
73  virtual void enter_preamble() = 0;
74  };
75 
76  } /* namespace digital */
77 } /* namespace gr */
78 
79 #endif /* INCLUDED_DIGITAL_OFDM_INSERT_PREAMBLE_H */
insert "pre-modulated" preamble symbols before each payload.
Definition: ofdm_insert_preamble.h:58
#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
boost::shared_ptr< ofdm_insert_preamble > sptr
Definition: ofdm_insert_preamble.h:62
The abstract base class for all 'terminal' processing blocks.A signal processing flow is constructed ...
Definition: block.h:60