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_mapper_bcv.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2006,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_MAPPER_BCV_H
24 #define INCLUDED_DIGITAL_OFDM_MAPPER_BCV_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 take a stream of bytes in and map to a vector of complex
35  * constellation points suitable for IFFT input to be used in an
36  * ofdm modulator.
37  * \ingroup ofdm_blk
38  *
39  * \details
40  * Abstract class must be subclassed with specific mapping.
41  */
42  class DIGITAL_API ofdm_mapper_bcv : virtual public sync_block
43  {
44  public:
45  // gr::digital::ofdm_mapper_bcv::sptr
46  typedef boost::shared_ptr<ofdm_mapper_bcv> sptr;
47 
48  /*!
49  * Make an OFDM mapper block.
50  *
51  * \param constellation vector of OFDM carrier symbols in complex space
52  * \param msgq_limit limit on number of messages the queue can store
53  * \param occupied_carriers The number of subcarriers with data in the received symbol
54  * \param fft_length The size of the FFT vector (occupied_carriers + unused carriers)
55  */
56  static sptr make(const std::vector<gr_complex> &constellation,
57  unsigned msgq_limit,
58  unsigned occupied_carriers,
59  unsigned int fft_length);
60 
61  virtual msg_queue::sptr msgq() const = 0;
62  };
63 
64  } /* namespace digital */
65 } /* namespace gr */
66 
67 #endif /* INCLUDED_DIGITAL_OFDM_MAPPER_BCV_H */
boost::shared_ptr< msg_queue > sptr
Definition: msg_queue.h:47
An abstracted constellation object.
Definition: constellation.h:62
#define DIGITAL_API
Definition: gr-digital/include/gnuradio/digital/api.h:30
boost::shared_ptr< ofdm_mapper_bcv > sptr
Definition: ofdm_mapper_bcv.h:46
take a stream of bytes in and map to a vector of complex constellation points suitable for IFFT input...
Definition: ofdm_mapper_bcv.h:42
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