GNU Radio 3.6.5 C++ API

gr_packed_to_unpacked_ss.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 overwritten
00024 
00025 #ifndef INCLUDED_GR_GR_PACKED_TO_UNPACKED_SS_H
00026 #define INCLUDED_GR_GR_PACKED_TO_UNPACKED_SS_H
00027 
00028 #include <gr_core_api.h>
00029 #include <gr_block.h>
00030 #include <gr_endianness.h>
00031 
00032 class gr_packed_to_unpacked_ss;
00033 typedef boost::shared_ptr<gr_packed_to_unpacked_ss> gr_packed_to_unpacked_ss_sptr;
00034 
00035 GR_CORE_API gr_packed_to_unpacked_ss_sptr
00036 gr_make_packed_to_unpacked_ss (unsigned int bits_per_chunk, gr_endianness_t endianness);
00037 
00038 /*!
00039  * \brief Convert a stream of packed bytes or shorts to stream of unpacked bytes or shorts.
00040  * \ingroup converter_blk
00041  *
00042  * input: stream of short; output: stream of short
00043  *
00044  * This is the inverse of gr_unpacked_to_packed_XX.
00045  *
00046  * The bits in the bytes or shorts input stream are grouped into chunks of
00047  * \p bits_per_chunk bits and each resulting chunk is written right-
00048  * justified to the output stream of bytes or shorts.
00049  * All b or 16 bits of the each input bytes or short are processed.
00050  * The right thing is done if bits_per_chunk is not a power of two.
00051  *
00052  * The combination of gr_packed_to_unpacked_XX_ followed by
00053  * gr_chunks_to_symbols_Xf or gr_chunks_to_symbols_Xc handles the
00054  * general case of mapping from a stream of bytes or shorts into
00055  * arbitrary float or complex symbols.
00056  *
00057  * \sa gr_packed_to_unpacked_bb, gr_unpacked_to_packed_bb,
00058  * \sa gr_packed_to_unpacked_ss, gr_unpacked_to_packed_ss,
00059  * \sa gr_chunks_to_symbols_bf, gr_chunks_to_symbols_bc.
00060  * \sa gr_chunks_to_symbols_sf, gr_chunks_to_symbols_sc.
00061  */
00062 
00063 class GR_CORE_API gr_packed_to_unpacked_ss : public gr_block
00064 {
00065   friend GR_CORE_API gr_packed_to_unpacked_ss_sptr
00066   gr_make_packed_to_unpacked_ss (unsigned int bits_per_chunk, gr_endianness_t endianness);
00067 
00068   gr_packed_to_unpacked_ss (unsigned int bits_per_chunk, gr_endianness_t endianness);
00069 
00070   unsigned int    d_bits_per_chunk;
00071   gr_endianness_t d_endianness;
00072   unsigned int    d_index;
00073 
00074  public:
00075   void forecast(int noutput_items, gr_vector_int &ninput_items_required);
00076   int general_work (int noutput_items,
00077                     gr_vector_int &ninput_items,
00078                     gr_vector_const_void_star &input_items,
00079                     gr_vector_void_star &output_items);
00080 
00081   bool check_topology(int ninputs, int noutputs) { return ninputs == noutputs; }
00082 
00083 };
00084 
00085 #endif