GNU Radio 3.7.2 C++ API
encode_ccsds_27_bb.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2012 Free Software Foundation, Inc.
4  *
5  * This file is part of GNU Radio
6  *
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  *
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING. If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22 
23 #ifndef INCLUDED_FEC_ENCODE_CCSDS_27_BB_H
24 #define INCLUDED_FEC_ENCODE_CCSDS_27_BB_H
25 
26 #include <gnuradio/fec/api.h>
28 
29 namespace gr {
30  namespace fec {
31 
32  /*! \brief A rate 1/2, k=7 convolutional encoder for the CCSDS standard
33  * \ingroup error_coding_blk
34  *
35  * \details
36  * This block performs convolutional encoding using the CCSDS standard
37  * polynomial ("Voyager").
38  *
39  * The input is an MSB first packed stream of bits.
40  *
41  * The output is a stream of symbols 0 or 1 representing the encoded data.
42  *
43  * As a rate 1/2 code, there will be 16 output symbols for every input byte.
44  *
45  * This block is designed for continuous data streaming, not packetized data.
46  * There is no provision to "flush" the encoder.
47  */
48 
50  {
51  public:
52 
53  // gr::fec::encode_ccsds_27_bb::sptr
55 
56  static sptr make();
57  };
58 
59  } /* namespace fec */
60 } /* namespace gr */
61 
62 #endif /* INCLUDED_FEC_ENCODE_CCSDS_27_BB_H */
shared_ptr documentation stub
Definition: shared_ptr_docstub.h:15
synchronous 1:N input to output with historyOverride work to provide the signal processing implementa...
Definition: sync_interpolator.h:37
A rate 1/2, k=7 convolutional encoder for the CCSDS standard.
Definition: encode_ccsds_27_bb.h:49
#define FEC_API
Definition: gr-fec/include/gnuradio/fec/api.h:30
boost::shared_ptr< encode_ccsds_27_bb > sptr
Definition: encode_ccsds_27_bb.h:54