GNU Radio's M17 Package
m17_coder.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2023 jmfriedt.
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_M17_M17_CODER_H
22 #define INCLUDED_M17_M17_CODER_H
23 
24 #include <m17/api.h>
25 #include <gnuradio/block.h>
26 
27 namespace gr {
28  namespace m17 {
29 
30  /*!
31  * \brief <+description of block+>
32  * \ingroup m17
33  *
34  */
35  class M17_API m17_coder : virtual public gr::block
36  {
37  public:
38  typedef boost::shared_ptr<m17_coder> sptr;
39 
40  /*!
41  * \brief Return a shared_ptr to a new instance of m17::m17_coder.
42  *
43  * To avoid accidental use of raw pointers, m17::m17_coder's
44  * constructor is in a private implementation
45  * class. m17::m17_coder::make is the public interface for
46  * creating new instances.
47  */
48  static sptr make(std::string src_id,std::string dst_id,short type,std::string meta,float samp_rate,bool debug);
49  virtual void set_meta(std::string meta)=0;
50  virtual void set_src_id(std::string src_id)=0;
51  virtual void set_dst_id(std::string dst_id)=0;
52  virtual void set_samp_rate(float samp_rate)=0;
53  virtual void set_debug(bool debug)=0;
54  };
55 
56  } // namespace m17
57 } // namespace gr
58 
59 #endif /* INCLUDED_M17_M17_CODER_H */
60 
boost::shared_ptr< m17_coder > sptr
Definition: m17_coder.h:38
#define M17_API
Definition: api.h:31
Definition: m17_coder.h:27
<+description of block+>
Definition: m17_coder.h:35