GNU Radio's SATNOGS Package
crc_async.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * gr-satnogs: SatNOGS GNU Radio Out-Of-Tree Module
4  *
5  * Copyright (C) 2020, Libre Space Foundation <http://libre.space>
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 of the License, or
10  * (at your option) 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 INCLUDE_SATNOGS_CRC_ASYNC_H_
22 #define INCLUDE_SATNOGS_CRC_ASYNC_H_
23 
24 
25 #include <satnogs/api.h>
26 #include <gnuradio/block.h>
27 #include <satnogs/crc.h>
28 
29 namespace gr {
30 namespace satnogs {
31 
32 /*!
33  * \brief An extended version of the CRC Async block of GNU Radio
34  * \ingroup satnogs
35  *
36  */
37 class SATNOGS_API crc_async : virtual public gr::block {
38 public:
39  typedef boost::shared_ptr<crc_async> sptr;
40 
41  /*!
42  * \brief Return a shared_ptr to a new instance of satnogs::crc_async.
43  *
44  * To avoid accidental use of raw pointers, satnogs::crc_async
45  * constructor is in a private implementation
46  * class. satnogs::crc_async::make is the public interface for
47  * creating new instances.
48  */
49  static sptr make(crc::crc_t crc, bool check = false);
50 };
51 
52 } // namespace satnogs
53 } // namespace gr
54 
55 
56 #endif /* INCLUDE_SATNOGS_CRC_ASYNC_H_ */
boost::shared_ptr< crc_async > sptr
Definition: crc_async.h:39
An extended version of the CRC Async block of GNU Radio.
Definition: crc_async.h:37
Definition: amsat_duv_decoder.h:29
enum gr::satnogs::crc::crc_type crc_t
Definition: crc.h:33
#define SATNOGS_API
Definition: api.h:30