GNU Radio 3.6.5 C++ API

pack_k_bits_bb.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2012-2013 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_GR_PACK_K_BITS_BB_H
00024 #define INCLUDED_GR_PACK_K_BITS_BB_H
00025 
00026 #include <blocks/api.h>
00027 #include <gr_sync_decimator.h>
00028 
00029 namespace gr {
00030   namespace blocks {
00031 
00032     /*!
00033      * \brief Converts a stream of bytes with 1 bit in the LSB to a
00034      * byte with k relevent bits.
00035      * \ingroup byte_operators_blk
00036      */
00037     class BLOCKS_API pack_k_bits_bb : virtual public gr_sync_decimator
00038     {
00039     public:
00040       // gr::blocks::pack_k_bits_bb::sptr
00041       typedef boost::shared_ptr<pack_k_bits_bb> sptr;
00042       
00043       /*!
00044        * \brief Make a pack_k_bits block.
00045        * \param k number of bits to be packed.
00046        */
00047       static sptr make(unsigned k);
00048     };
00049 
00050   } /* namespace blocks */
00051 } /* namespace gr */
00052 
00053 #endif /* INCLUDED_GR_PACK_K_BITS_BB_H */