GNU Radio 3.7.1 C++ API
ofdm_mapper_bcv.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2006,2007,2011,2012 Free Software Foundation, Inc.
00004  * 
00005  * This file is part of GNU Radio
00006  * 
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  * 
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  * 
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_DIGITAL_OFDM_MAPPER_BCV_H
00024 #define INCLUDED_DIGITAL_OFDM_MAPPER_BCV_H
00025 
00026 #include <gnuradio/digital/api.h>
00027 #include <gnuradio/sync_block.h>
00028 #include <gnuradio/msg_queue.h>
00029 
00030 namespace gr {
00031   namespace digital {
00032 
00033     /*!
00034      * \brief take a stream of bytes in and map to a vector of complex
00035      * constellation points suitable for IFFT input to be used in an
00036      * ofdm modulator.
00037      * \ingroup ofdm_blk
00038      *
00039      * \details
00040      * Abstract class must be subclassed with specific mapping.
00041      */
00042     class DIGITAL_API ofdm_mapper_bcv : virtual public sync_block
00043     {
00044     public:
00045       // gr::digital::ofdm_mapper_bcv::sptr
00046       typedef boost::shared_ptr<ofdm_mapper_bcv> sptr;
00047 
00048       /*!
00049        * Make an OFDM mapper block.
00050        *
00051        * \param constellation vector of OFDM carrier symbols in complex space
00052        * \param msgq_limit limit on number of messages the queue can store
00053        * \param occupied_carriers The number of subcarriers with data in the received symbol
00054        * \param fft_length The size of the FFT vector (occupied_carriers + unused carriers)
00055        */
00056       static sptr make(const std::vector<gr_complex> &constellation,
00057                        unsigned msgq_limit, 
00058                        unsigned occupied_carriers,
00059                        unsigned int fft_length);
00060 
00061       virtual msg_queue::sptr msgq() const = 0;
00062     };
00063 
00064   } /* namespace digital */
00065 } /* namespace gr */
00066 
00067 #endif /* INCLUDED_DIGITAL_OFDM_MAPPER_BCV_H */