GNU Radio's LORA_SDR Package
header.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_HEADER_H
23#define INCLUDED_LORA_SDR_HEADER_H
24
25#include <lora_sdr/api.h>
26#include <gnuradio/block.h>
27
28namespace gr {
29 namespace lora_sdr {
30
31 /*!
32 * \brief Encode the header of the data package if implicit header mode (denoted by m_impl_head) is turned on
33 * For more information about the implementation visit header_impl
34 * \ingroup lora_sdr
35 *
36 */
37 class LORA_SDR_API header : virtual public gr::block
38 {
39 public:
40 typedef std::shared_ptr<header> sptr;
41
42 /*!
43 * \brief Return a shared_ptr to a new instance of lora_sdr::header.
44 *
45 * To avoid accidental use of raw pointers, lora_sdr::header's
46 * constructor is in a private implementation
47 * class. lora_sdr::header::make is the public interface for
48 * creating new instances.
49 */
50 static sptr make(bool impl_head, bool has_crc, uint8_t cr);
51 };
52
53 } // namespace lora_sdr
54} // namespace gr
55
56#endif /* INCLUDED_LORA_SDR_HEADER_H */
57
#define LORA_SDR_API
Definition: api.h:19
Encode the header of the data package if implicit header mode (denoted by m_impl_head) is turned on F...
Definition: header.h:38
static sptr make(bool impl_head, bool has_crc, uint8_t cr)
Return a shared_ptr to a new instance of lora_sdr::header.
std::shared_ptr< header > sptr
Definition: header.h:40
Definition: add_crc.h:28