GNU Radio Manual and C++ API Reference  3.7.9.2
The Free & Open Software Radio Ecosystem
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
packed_to_unpacked_bb.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2006,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 // WARNING: this file is machine generated. Edits will be overwritten
24 
25 #ifndef INCLUDED_BLOCKS_PACKED_TO_UNPACKED_BB_H
26 #define INCLUDED_BLOCKS_PACKED_TO_UNPACKED_BB_H
27 
28 #include <gnuradio/blocks/api.h>
29 #include <gnuradio/block.h>
30 #include <gnuradio/endianness.h>
31 
32 namespace gr {
33  namespace blocks {
34 
35  /*!
36  * \brief Convert a stream of packed bytes or shorts to stream of unpacked bytes or shorts.
37  * \ingroup byte_operators_blk
38  *
39  * \details
40  * input: stream of unsigned char; output: stream of unsigned char
41  *
42  * This is the inverse of gr::blocks::unpacked_to_packed_XX.
43  *
44  * The bits in the bytes or shorts input stream are grouped into
45  * chunks of \p bits_per_chunk bits and each resulting chunk is
46  * written right- justified to the output stream of bytes or
47  * shorts. All b or 16 bits of the each input bytes or short are
48  * processed. The right thing is done if bits_per_chunk is not a
49  * power of two.
50  *
51  * The combination of gr::blocks::packed_to_unpacked_XX_ followed by
52  * gr_chunks_to_symbols_Xf or gr_chunks_to_symbols_Xc handles the
53  * general case of mapping from a stream of bytes or shorts into
54  * arbitrary float or complex symbols.
55  *
56  * \sa gr::blocks::packed_to_unpacked_bb, gr::blocks::unpacked_to_packed_bb,
57  * \sa gr::blocks::packed_to_unpacked_ss, gr::blocks::unpacked_to_packed_ss,
58  * \sa gr::blocks::chunks_to_symbols_bf, gr::blocks::chunks_to_symbols_bc.
59  * \sa gr::blocks::chunks_to_symbols_sf, gr::blocks::chunks_to_symbols_sc.
60  */
61  class BLOCKS_API packed_to_unpacked_bb : virtual public block
62  {
63  public:
64  // gr::blocks::packed_to_unpacked_bb::sptr
65  typedef boost::shared_ptr<packed_to_unpacked_bb> sptr;
66 
67  static sptr make(unsigned int bits_per_chunk,
68  endianness_t endianness);
69  };
70 
71  } /* namespace blocks */
72 } /* namespace gr */
73 
74 #endif /* INCLUDED_BLOCKS_PACKED_TO_UNPACKED_BB_H */
endianness_t
Definition: endianness.h:28
Convert a stream of packed bytes or shorts to stream of unpacked bytes or shorts. ...
Definition: packed_to_unpacked_bb.h:61
Include this header to use the message passing features.
Definition: logger.h:131
#define BLOCKS_API
Definition: gr-blocks/include/gnuradio/blocks/api.h:30
The abstract base class for all 'terminal' processing blocks.A signal processing flow is constructed ...
Definition: block.h:60
boost::shared_ptr< packed_to_unpacked_bb > sptr
Definition: packed_to_unpacked_bb.h:65