GNU Radio Manual and C++ API Reference  3.7.13.4
The Free & Open Software Radio Ecosystem
pack_k_bits_bb.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2012-2013 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_GR_PACK_K_BITS_BB_H
24 #define INCLUDED_GR_PACK_K_BITS_BB_H
25 
26 #include <gnuradio/blocks/api.h>
28 
29 namespace gr {
30  namespace blocks {
31 
32  /*!
33  * \brief Converts a stream of bytes with 1 bit in the LSB to a
34  * byte with k relevant bits.
35  *
36  * This block takes in K bytes at a time, and uses the least significant
37  * bit to form a new byte.
38  *
39  * Example:
40  * k = 4
41  * in = [0,1,0,1, 0x81,0x00,0x00,0x00]
42  * out = [0x05, 0x08]
43  *
44  * \ingroup byte_operators_blk
45  */
46  class BLOCKS_API pack_k_bits_bb : virtual public sync_decimator
47  {
48  public:
49  // gr::blocks::pack_k_bits_bb::sptr
50  typedef boost::shared_ptr<pack_k_bits_bb> sptr;
51 
52  /*!
53  * \brief Make a pack_k_bits block.
54  * \param k number of bits to be packed.
55  */
56  static sptr make(unsigned k);
57  };
58 
59  } /* namespace blocks */
60 } /* namespace gr */
61 
62 #endif /* INCLUDED_GR_PACK_K_BITS_BB_H */
boost::shared_ptr< pack_k_bits_bb > sptr
Definition: pack_k_bits_bb.h:50
Converts a stream of bytes with 1 bit in the LSB to a byte with k relevant bits.
Definition: pack_k_bits_bb.h:46
Include this header to use the message passing features.
Definition: logger.h:695
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
synchronous N:1 input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_decimator.h:37