GNU Radio's SATNOGS Package
frame_encoder.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 INCLUDED_SATNOGS_FRAME_ENCODER_H
22 #define INCLUDED_SATNOGS_FRAME_ENCODER_H
23 
24 #include <satnogs/api.h>
25 #include <satnogs/encoder.h>
26 #include <gnuradio/block.h>
27 
28 namespace gr {
29 namespace satnogs {
30 
31 /*!
32  * \brief <+description of block+>
33  * \ingroup satnogs
34  *
35  */
36 class SATNOGS_API frame_encoder : virtual public gr::block {
37 public:
38  typedef boost::shared_ptr<frame_encoder> sptr;
39 
40  /*!
41  * \brief Return a shared_ptr to a new instance of satnogs::frame_encoder.
42  *
43  * To avoid accidental use of raw pointers, satnogs::frame_encoder's
44  * constructor is in a private implementation
45  * class. satnogs::frame_encoder::make is the public interface for
46  * creating new instances.
47  */
48  static sptr make(encoder::encoder_sptr enc);
49 };
50 
51 } // namespace satnogs
52 } // namespace gr
53 
54 #endif /* INCLUDED_SATNOGS_FRAME_ENCODER_H */
55 
boost::shared_ptr< frame_encoder > sptr
Definition: frame_encoder.h:38
<+description of block+>
Definition: frame_encoder.h:36
Definition: amsat_duv_decoder.h:29
#define SATNOGS_API
Definition: api.h:30