7b331e9843fdad15edeecec620a135a1b5cde74e
[debian/gnuradio] / gnuradio-core / src / lib / gengen / gr_chunks_to_symbols_bf.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004 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 over written
24
25 #ifndef INCLUDED_GR_CHUNKS_TO_SYMBOLS_BF_H
26 #define INCLUDED_GR_CHUNKS_TO_SYMBOLS_BF_H
27
28 #include <gr_sync_interpolator.h>
29
30 class gr_chunks_to_symbols_bf;
31 typedef boost::shared_ptr<gr_chunks_to_symbols_bf> gr_chunks_to_symbols_bf_sptr;
32
33 gr_chunks_to_symbols_bf_sptr gr_make_chunks_to_symbols_bf (const std::vector<float> &symbol_table, const int D = 1);
34
35 /*!
36  * \brief Map a stream of symbol indexes (unpacked bytes or shorts) to stream of float or complex onstellation points.in \p D dimensions (\p D = 1 by default)
37  * \ingroup converter_blk
38  *
39  * input: stream of unsigned char; output: stream of float
40  *
41  * out[n D + k] = symbol_table[in[n] D + k], k=0,1,...,D-1
42  *
43  * The combination of gr_packed_to_unpacked_XX followed by
44  * gr_chunks_to_symbols_XY handles the general case of mapping 
45  * from a stream of bytes or shorts into arbitrary float
46  * or complex symbols.
47  *
48  * \sa gr_packed_to_unpacked_bb, gr_unpacked_to_packed_bb,
49  * \sa gr_packed_to_unpacked_ss, gr_unpacked_to_packed_ss,
50  * \sa gr_chunks_to_symbols_bf, gr_chunks_to_symbols_bc.
51  * \sa gr_chunks_to_symbols_sf, gr_chunks_to_symbols_sc.
52  */
53
54 class gr_chunks_to_symbols_bf : public gr_sync_interpolator
55 {
56   friend gr_chunks_to_symbols_bf_sptr gr_make_chunks_to_symbols_bf (const std::vector<float> &symbol_table, const int D);
57
58   int d_D;
59   std::vector<float> d_symbol_table;
60   gr_chunks_to_symbols_bf (const std::vector<float> &symbol_table, const int D = 1);
61
62  public:
63   int D () const { return d_D; }
64   std::vector<float> symbol_table () const { return d_symbol_table; }
65   int work (int noutput_items,
66             gr_vector_const_void_star &input_items,
67             gr_vector_void_star &output_items);
68
69   bool check_topology(int ninputs, int noutputs) { return ninputs == noutputs; }
70 };
71
72 #endif