GNU Radio's LORA_SDR Package
hamming_enc.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2022 Tapparel Joachim @EPFL,TCL.
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 
22 #ifndef INCLUDED_LORA_SDR_HAMMING_ENC_H
23 #define INCLUDED_LORA_SDR_HAMMING_ENC_H
24 
25 #include <gnuradio/lora_sdr/api.h>
26 #include <gnuradio/sync_block.h>
27 
28 namespace gr {
29  namespace lora_sdr {
30 
31  /*!
32  * \brief <+description of block+>
33  * \ingroup lora_sdr
34  *
35  */
36  class LORA_SDR_API hamming_enc : virtual public gr::sync_block
37  {
38  public:
39  typedef std::shared_ptr<hamming_enc> sptr;
40 
41  virtual void set_cr(uint8_t cr)=0;
42  virtual uint8_t get_cr()=0;
43  virtual void set_sf(uint8_t sf)=0;
44 
45 
46  /*!
47  * \brief Return a shared_ptr to a new instance of lora_sdr::hamming_enc.
48  *
49  * To avoid accidental use of raw pointers, lora_sdr::hamming_enc's
50  * constructor is in a private implementation
51  * class. lora_sdr::hamming_enc::make is the public interface for
52  * creating new instances.
53  */
54  static sptr make(uint8_t cr, uint8_t sf);
55  };
56 
57  } // namespace lora_sdr
58 } // namespace gr
59 
60 #endif /* INCLUDED_LORA_SDR_HAMMING_ENC_H */
61 
#define LORA_SDR_API
Definition: api.h:19
<+description of block+>
Definition: hamming_enc.h:37
virtual uint8_t get_cr()=0
virtual void set_cr(uint8_t cr)=0
static sptr make(uint8_t cr, uint8_t sf)
Return a shared_ptr to a new instance of lora_sdr::hamming_enc.
std::shared_ptr< hamming_enc > sptr
Definition: hamming_enc.h:39
virtual void set_sf(uint8_t sf)=0
Definition: add_crc.h:28