diff options
Diffstat (limited to 'gr-blocks/include/gnuradio/blocks/pack_k_bits_bb.h')
-rw-r--r-- | gr-blocks/include/gnuradio/blocks/pack_k_bits_bb.h | 54 |
1 files changed, 27 insertions, 27 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/pack_k_bits_bb.h b/gr-blocks/include/gnuradio/blocks/pack_k_bits_bb.h index d71e73c580..bef2dfc0ef 100644 --- a/gr-blocks/include/gnuradio/blocks/pack_k_bits_bb.h +++ b/gr-blocks/include/gnuradio/blocks/pack_k_bits_bb.h @@ -21,42 +21,42 @@ */ #ifndef INCLUDED_GR_PACK_K_BITS_BB_H -#define INCLUDED_GR_PACK_K_BITS_BB_H +#define INCLUDED_GR_PACK_K_BITS_BB_H #include <gnuradio/blocks/api.h> #include <gnuradio/sync_decimator.h> namespace gr { - namespace blocks { +namespace blocks { + +/*! + * \brief Converts a stream of bytes with 1 bit in the LSB to a + * byte with k relevant bits. + * + * This block takes in K bytes at a time, and uses the least significant + * bit to form a new byte. + * + * Example: + * k = 4 + * in = [0,1,0,1, 0x81,0x00,0x00,0x00] + * out = [0x05, 0x08] + * + * \ingroup byte_operators_blk + */ +class BLOCKS_API pack_k_bits_bb : virtual public sync_decimator +{ +public: + // gr::blocks::pack_k_bits_bb::sptr + typedef boost::shared_ptr<pack_k_bits_bb> sptr; /*! - * \brief Converts a stream of bytes with 1 bit in the LSB to a - * byte with k relevant bits. - * - * This block takes in K bytes at a time, and uses the least significant - * bit to form a new byte. - * - * Example: - * k = 4 - * in = [0,1,0,1, 0x81,0x00,0x00,0x00] - * out = [0x05, 0x08] - * - * \ingroup byte_operators_blk + * \brief Make a pack_k_bits block. + * \param k number of bits to be packed. */ - class BLOCKS_API pack_k_bits_bb : virtual public sync_decimator - { - public: - // gr::blocks::pack_k_bits_bb::sptr - typedef boost::shared_ptr<pack_k_bits_bb> sptr; - - /*! - * \brief Make a pack_k_bits block. - * \param k number of bits to be packed. - */ - static sptr make(unsigned k); - }; + static sptr make(unsigned k); +}; - } /* namespace blocks */ +} /* namespace blocks */ } /* namespace gr */ #endif /* INCLUDED_GR_PACK_K_BITS_BB_H */ |