GNU Radio's LORA_SDR Package
gray_enc.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2019 <+YOU OR YOUR COMPANY+>.
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_GRAY_ENC_H
23 #define INCLUDED_LORA_SDR_GRAY_ENC_H
24 
25 #include <lora_sdr/api.h>
26 #include <gnuradio/sync_block.h>
27 
28 namespace gr {
29  namespace lora_sdr {
30 
31  /*!
32  * \brief Modulate the payload with an Gray map.
33  * This ensures that bits are modulated such that two subsequent symbols differ one bit.
34  * For more information about the implementation visit gray_enc_impl
35  * \ingroup lora_sdr
36  *
37  */
38  class LORA_SDR_API gray_enc : virtual public gr::sync_block
39  {
40  public:
41  typedef std::shared_ptr<gray_enc> sptr;
42 
43  /*!
44  * \brief Return a shared_ptr to a new instance of lora_sdr::gray_enc.
45  *
46  * To avoid accidental use of raw pointers, lora_sdr::gray_enc's
47  * constructor is in a private implementation
48  * class. lora_sdr::gray_enc::make is the public interface for
49  * creating new instances.
50  */
51  static sptr make();
52  };
53 
54  } // namespace lora_sdr
55 } // namespace gr
56 
57 #endif /* INCLUDED_LORA_SDR_GRAY_ENC_H */
58 
LORA_SDR_API
#define LORA_SDR_API
Definition: api.h:19
gr::lora_sdr::gray_enc
Modulate the payload with an Gray map. This ensures that bits are modulated such that two subsequent ...
Definition: gray_enc.h:38
gr::lora_sdr::gray_enc::sptr
std::shared_ptr< gray_enc > sptr
Definition: gray_enc.h:41
gr
Definition: add_crc.h:28
api.h