GNU Radio's SATELLITES Package
include/satellites/encode_rs.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2018,2020 Daniel Estevez <daniel@destevez.net>
4  *
5  * This file is part of gr-satellites
6  *
7  * SPDX-License-Identifier: GPL-3.0-or-later
8  *
9  */
10 
11 #ifndef INCLUDED_SATELLITES_ENCODE_RS_H
12 #define INCLUDED_SATELLITES_ENCODE_RS_H
13 
14 #include <gnuradio/block.h>
15 #include <satellites/api.h>
16 
17 namespace gr {
18 namespace satellites {
19 
20 /*!
21  * \brief <+description of block+>
22  * \ingroup satellites
23  *
24  */
25 class SATELLITES_API encode_rs : virtual public gr::block
26 {
27 public:
28  typedef std::shared_ptr<encode_rs> sptr;
29 
30  /*!
31  * \brief Return a shared_ptr to a new instance of satellites::encode_rs.
32  *
33  * To avoid accidental use of raw pointers, satellites::encode_rs's
34  * constructor is in a private implementation
35  * class. satellites::encode_rs::make is the public interface for
36  * creating new instances.
37  */
38  static sptr make(bool dual_basis, int interleave = 1);
39 
40  /*!
41  * \brief Return a shared_ptr to a new instance of satellites::encode_rs.
42  *
43  * To avoid accidental use of raw pointers, satellites::encode_rs's
44  * constructor is in a private implementation
45  * class. satellites::encode_rs::make is the public interface for
46  * creating new instances.
47  */
48  static sptr
49  make(int symsize, int gfpoly, int fcr, int prim, int nroots, int interleave = 1);
50 };
51 
52 } // namespace satellites
53 } // namespace gr
54 
55 #endif /* INCLUDED_SATELLITES_ENCODE_RS_H */
#define SATELLITES_API
Definition: api.h:31
<+description of block+>
Definition: include/satellites/encode_rs.h:26
std::shared_ptr< encode_rs > sptr
Definition: include/satellites/encode_rs.h:28
static sptr make(bool dual_basis, int interleave=1)
Return a shared_ptr to a new instance of satellites::encode_rs.
static sptr make(int symsize, int gfpoly, int fcr, int prim, int nroots, int interleave=1)
Return a shared_ptr to a new instance of satellites::encode_rs.
rs nroots
Definition: init_rs.h:80
rs fcr
Definition: init_rs.h:78
rs prim
Definition: init_rs.h:79
Definition: ax100_decode.h:17