Imported Upstream version 3.2.2
[debian/gnuradio] / gr-trellis / src / lib / trellis_encoder_XX.h.t
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@
24
25 #ifndef @GUARD_NAME@
26 #define @GUARD_NAME@
27
28 #include "fsm.h"
29 #include <gr_sync_block.h>
30
31 class @NAME@;
32 typedef boost::shared_ptr<@NAME@> @SPTR_NAME@;
33
34 @SPTR_NAME@ trellis_make_@BASE_NAME@ (const fsm &FSM, int ST);
35
36 /*!
37  * \brief Convolutional encoder.
38  * \ingroup coding_blk
39  */
40 class @NAME@ : public gr_sync_block
41 {
42 private:
43   friend @SPTR_NAME@ trellis_make_@BASE_NAME@ (const fsm &FSM, int ST);
44   fsm d_FSM;
45   int d_ST;
46   @NAME@ (const fsm &FSM, int ST); 
47
48 public:
49   fsm FSM () const { return d_FSM; }
50   int ST () const { return d_ST; }
51
52   int work (int noutput_items,
53             gr_vector_const_void_star &input_items,
54             gr_vector_void_star &output_items);
55 };
56
57 #endif