GNU Radio's FRAMERS Package
gr_hdlc_deframer_b.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2015 Free Software Foundation, Inc
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_FRAMERS_GR_HDLC_DEFRAMER_B_H
23 #define INCLUDED_FRAMERS_GR_HDLC_DEFRAMER_B_H
24 
25 #include <framers/api.h>
26 #include <gnuradio/block.h>
27 #include <gnuradio/blocks/pdu.h>
28 
29 namespace gr {
30  namespace framers {
31 
32  /*!
33  * \brief <+description of block+>
34  * \ingroup framers
35  *
36  */
37  class FRAMERS_API gr_hdlc_deframer_b : virtual public gr::block
38  {
39  public:
40  typedef boost::shared_ptr<gr_hdlc_deframer_b> sptr;
41 
42  /*!
43  * \brief Return a shared_ptr to a new instance of framers::gr_hdlc_deframer_b.
44  *
45  * To avoid accidental use of raw pointers, framers::gr_hdlc_deframer_b's
46  * constructor is in a private implementation
47  * class. framers::gr_hdlc_deframer_b::make is the public interface for
48  * creating new instances.
49  */
50  static sptr make(int dlci);
51 
52  // Getters for public statistics
53  virtual float get_ber() = 0;
54  };
55 
56  } // namespace framers
57 } // namespace gr
58 
59 #endif /* INCLUDED_FRAMERS_GR_HDLC_DEFRAMER_B_H */
60 
boost::shared_ptr< gr_hdlc_deframer_b > sptr
Definition: gr_hdlc_deframer_b.h:40
&lt;+description of block+&gt;
Definition: gr_hdlc_deframer_b.h:37
#define FRAMERS_API
Definition: api.h:30