GNU Radio's SATELLITES Package
decode_rs_general.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2018 Daniel Estevez <daniel@destevez.net>.
4  *
5  * This is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 3, or (at your option)
8  * any later version.
9  *
10  * This software is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this software; see the file COPYING. If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street,
18  * Boston, MA 02110-1301, USA.
19  */
20 
21 #ifndef INCLUDED_SATELLITES_DECODE_RS_GENERAL_H
22 #define INCLUDED_SATELLITES_DECODE_RS_GENERAL_H
23 
24 #include <satellites/api.h>
25 #include <gnuradio/block.h>
26 
27 namespace gr {
28  namespace satellites {
29 
30  /*!
31  * \brief <+description of block+>
32  * \ingroup satellites
33  *
34  */
35  class SATELLITES_API decode_rs_general : virtual public gr::block
36  {
37  public:
38  typedef boost::shared_ptr<decode_rs_general> sptr;
39 
40  /*!
41  * \brief Return a shared_ptr to a new instance of satellites::decode_rs_general.
42  *
43  * To avoid accidental use of raw pointers, satellites::decode_rs_general's
44  * constructor is in a private implementation
45  * class. satellites::decode_rs_general::make is the public interface for
46  * creating new instances.
47  */
48  static sptr make(int gfpoly, int fcr, int prim, int nroots, bool verbose);
49  };
50 
51  } // namespace satellites
52 } // namespace gr
53 
54 #endif /* INCLUDED_SATELLITES_DECODE_RS_GENERAL_H */
55 
#define SATELLITES_API
Definition: api.h:30
<+description of block+>
Definition: decode_rs_general.h:36
boost::shared_ptr< decode_rs_general > sptr
Definition: decode_rs_general.h:38
static sptr make(int gfpoly, int fcr, int prim, int nroots, bool verbose)
Return a shared_ptr to a new instance of satellites::decode_rs_general.
Definition: ao40_deinterleaver.h:25