GNU Radio 3.7.1 C++ API
packed_to_unpacked_bb.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2006,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 // WARNING: this file is machine generated. Edits will be overwritten
00024 
00025 #ifndef INCLUDED_BLOCKS_PACKED_TO_UNPACKED_BB_H
00026 #define INCLUDED_BLOCKS_PACKED_TO_UNPACKED_BB_H
00027 
00028 #include <gnuradio/blocks/api.h>
00029 #include <gnuradio/block.h>
00030 #include <gnuradio/endianness.h>
00031 
00032 namespace gr {
00033   namespace blocks {
00034 
00035     /*!
00036      * \brief Convert a stream of packed bytes or shorts to stream of unpacked bytes or shorts.
00037      * \ingroup byte_operators_blk
00038      *
00039      * \details
00040      * input: stream of unsigned char; output: stream of unsigned char
00041      *
00042      * This is the inverse of gr::blocks::unpacked_to_packed_XX.
00043      *
00044      * The bits in the bytes or shorts input stream are grouped into
00045      * chunks of \p bits_per_chunk bits and each resulting chunk is
00046      * written right- justified to the output stream of bytes or
00047      * shorts. All b or 16 bits of the each input bytes or short are
00048      * processed. The right thing is done if bits_per_chunk is not a
00049      * power of two.
00050      *
00051      * The combination of gr::blocks::packed_to_unpacked_XX_ followed by
00052      * gr_chunks_to_symbols_Xf or gr_chunks_to_symbols_Xc handles the
00053      * general case of mapping from a stream of bytes or shorts into
00054      * arbitrary float or complex symbols.
00055      *
00056      * \sa gr::blocks::packed_to_unpacked_bb, gr::blocks::unpacked_to_packed_bb,
00057      * \sa gr::blocks::packed_to_unpacked_ss, gr::blocks::unpacked_to_packed_ss,
00058      * \sa gr::blocks::chunks_to_symbols_bf, gr::blocks::chunks_to_symbols_bc.
00059      * \sa gr::blocks::chunks_to_symbols_sf, gr::blocks::chunks_to_symbols_sc.
00060      */
00061     class BLOCKS_API packed_to_unpacked_bb : virtual public block
00062     {
00063     public:
00064       // gr::blocks::packed_to_unpacked_bb::sptr
00065       typedef boost::shared_ptr<packed_to_unpacked_bb> sptr;
00066 
00067       static sptr make(unsigned int bits_per_chunk,
00068                        endianness_t endianness);
00069     };
00070 
00071   } /* namespace blocks */
00072 } /* namespace gr */
00073 
00074 #endif /* INCLUDED_BLOCKS_PACKED_TO_UNPACKED_BB_H */