GNU Radio's SATELLITES Package
ao40_syncframe.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * gr-ao40 GNU Radio OOT module for AO-40 FEC
4  *
5  * Copyright 2017 Daniel Estevez <daniel@destevez.net>.
6  *
7  * This program 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  * This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
19  */
20 
21 #ifndef INCLUDED_SATELLITES_AO40_SYNCFRAME_H
22 #define INCLUDED_SATELLITES_AO40_SYNCFRAME_H
23 
24 #include <satellites/api.h>
25 #include <gnuradio/sync_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 ao40_syncframe : virtual public gr::sync_block
36  {
37  public:
38  typedef boost::shared_ptr<ao40_syncframe> sptr;
39 
40  /*!
41  * \brief Return a shared_ptr to a new instance of ao40::syncframe.
42  *
43  * To avoid accidental use of raw pointers, ao40::syncframe's
44  * constructor is in a private implementation
45  * class. ao40::syncframe::make is the public interface for
46  * creating new instances.
47  */
48  static sptr make(int threshold);
49  };
50 
51  } // namespace satellites
52 } // namespace gr
53 
54 #endif /* INCLUDED_SATELLITES_AO40_SYNCFRAME_H */
55 
#define SATELLITES_API
Definition: api.h:30
<+description of block+>
Definition: ao40_syncframe.h:36
static sptr make(int threshold)
Return a shared_ptr to a new instance of ao40::syncframe.
boost::shared_ptr< ao40_syncframe > sptr
Definition: ao40_syncframe.h:38
Definition: ao40_deinterleaver.h:25