GNU Radio 3.7.1 C++ API
constellation_decoder_cb.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 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_CONSTELLATION_DECODER_CB_H
00024 #define INCLUDED_DIGITAL_CONSTELLATION_DECODER_CB_H
00025 
00026 #include <gnuradio/digital/api.h>
00027 #include <gnuradio/digital/constellation.h>
00028 #include <gnuradio/block.h>
00029 
00030 namespace gr {
00031   namespace digital {
00032 
00033     /*!
00034      * \brief Constellation Decoder
00035      * \ingroup symbol_coding_blk
00036      *
00037      * \details
00038      * Decode a constellation's points from a complex space to
00039      * (unpacked) bits based on the map of the \p consetllation
00040      * object.
00041      */
00042     class DIGITAL_API constellation_decoder_cb
00043       : virtual public block
00044     {
00045     public:
00046       // gr::digital::constellation_decoder_cb::sptr
00047       typedef boost::shared_ptr<constellation_decoder_cb> sptr;
00048 
00049       /*!
00050        * \brief Make constellation decoder block.
00051        *
00052        * \param constellation A constellation derived from class
00053        * 'constellation'. Use base() method to get a shared pointer to
00054        * this base class type.
00055        */
00056       static sptr make(constellation_sptr constellation);
00057     };
00058 
00059   } /* namespace digital */
00060 } /* namespace gr */
00061 
00062 #endif /* INCLUDED_DIGITAL_CONSTELLATION_DECODER_CB_H */