GNU Radio 3.4.2 C++ API
gr_unpacked_to_packed_bb.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2006 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 over written
00024 
00025 #ifndef INCLUDED_GR_UNPACKED_TO_PACKED_BB_H
00026 #define INCLUDED_GR_UNPACKED_TO_PACKED_BB_H
00027 
00028 #include <gr_block.h>
00029 #include <gr_endianness.h>
00030 
00031 class gr_unpacked_to_packed_bb;
00032 typedef boost::shared_ptr<gr_unpacked_to_packed_bb> gr_unpacked_to_packed_bb_sptr;
00033 
00034 gr_unpacked_to_packed_bb_sptr 
00035 gr_make_unpacked_to_packed_bb (unsigned int bits_per_chunk, gr_endianness_t endianness);
00036 
00037 /*!
00038  * \brief Convert a stream of unpacked bytes or shorts into a stream of packed bytes or shorts.
00039  * \ingroup converter_blk
00040  *
00041  * input: stream of unsigned char; output: stream of unsigned char
00042  *
00043  * This is the inverse of gr_packed_to_unpacked_XX.
00044  *
00045  * The low \p bits_per_chunk bits are extracted from each input byte or short.
00046  * These bits are then packed densely into the output bytes or shorts, such that
00047  * all 8 or 16 bits of the output bytes or shorts are filled with valid input bits.
00048  * The 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 arbitrary float
00053  * or complex symbols.
00054  *
00055  * \sa gr_packed_to_unpacked_bb, gr_unpacked_to_packed_bb,
00056  * \sa gr_packed_to_unpacked_ss, gr_unpacked_to_packed_ss,
00057  * \sa gr_chunks_to_symbols_bf, gr_chunks_to_symbols_bc.
00058  * \sa gr_chunks_to_symbols_sf, gr_chunks_to_symbols_sc.
00059  */
00060 class gr_unpacked_to_packed_bb : public gr_block
00061 {
00062   friend gr_unpacked_to_packed_bb_sptr
00063   gr_make_unpacked_to_packed_bb (unsigned int bits_per_chunk, gr_endianness_t endianness);
00064 
00065   gr_unpacked_to_packed_bb (unsigned int bits_per_chunk, gr_endianness_t endianness);
00066 
00067   unsigned int    d_bits_per_chunk;
00068   gr_endianness_t d_endianness;
00069   unsigned int    d_index;
00070 
00071  public:
00072   void forecast(int noutput_items, gr_vector_int &ninput_items_required);
00073   int general_work (int noutput_items,
00074                     gr_vector_int &ninput_items,
00075                     gr_vector_const_void_star &input_items,
00076                     gr_vector_void_star &output_items);
00077 
00078   bool check_topology(int ninputs, int noutputs) { return ninputs == noutputs; }
00079 };
00080 
00081 #endif