GNU Radio 3.6.5 C++ API

unpacked_to_packed_ii.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_UNPACKED_TO_PACKED_II_H
00026 #define INCLUDED_BLOCKS_UNPACKED_TO_PACKED_II_H
00027 
00028 #include <blocks/api.h>
00029 #include <gr_block.h>
00030 #include <gr_endianness.h>
00031 
00032 namespace gr {
00033   namespace blocks {
00034 
00035     /*!
00036      * \brief Convert a stream of unpacked bytes or shorts into a stream of packed bytes or shorts.
00037      * \ingroup byte_operators_blk
00038      *
00039      * \details
00040      * input: stream of int; output: stream of int
00041      *
00042      * This is the inverse of gr::blocks::packed_to_unpacked_XX.
00043      *
00044      * The low \p bits_per_chunk bits are extracted from each input
00045      * byte or short.  These bits are then packed densely into the
00046      * output bytes or shorts, such that all 8 or 16 bits of the
00047      * output bytes or shorts are filled with valid input bits.  The
00048      * right thing is done if bits_per_chunk is not a power of two.
00049      *
00050      * The combination of gr_packed_to_unpacked_XX followed by
00051      * gr_chunks_to_symbols_Xf or gr_chunks_to_symbols_Xc handles the
00052      * general case of mapping from a stream of bytes or shorts into
00053      * arbitrary float or complex symbols.
00054      *
00055      * \sa gr::blocks::packed_to_unpacked_bb, gr::blocks::unpacked_to_packed_bb,
00056      * \sa gr::blocks::packed_to_unpacked_ss, gr::blocks::unpacked_to_packed_ss,
00057      * \sa gr::blocks::chunks_to_symbols_bf, gr::blocks::chunks_to_symbols_bc.
00058      * \sa gr::blocks::chunks_to_symbols_sf, gr::blocks::chunks_to_symbols_sc.
00059      */
00060     class BLOCKS_API unpacked_to_packed_ii : virtual public gr_block
00061     {
00062     public:
00063       // gr::blocks::unpacked_to_packed_ii::sptr
00064       typedef boost::shared_ptr<unpacked_to_packed_ii> sptr;
00065 
00066       static sptr make(unsigned int bits_per_chunk,
00067                        gr_endianness_t endianness);
00068     };
00069 
00070   } /* namespace blocks */
00071 } /* namespace gr */
00072 
00073 #endif /* INCLUDED_BLOCKS_UNPACKED_TO_PACKED_II_H */