GNU Radio's IRIDIUM_TOOLKIT Package
tagged_burst_to_pdu.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2016 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_IRIDIUM_TOOLKIT_TAGGED_BURST_TO_PDU_H
23 #define INCLUDED_IRIDIUM_TOOLKIT_TAGGED_BURST_TO_PDU_H
24 
25 #include <iridium/api.h>
26 #include <gnuradio/sync_block.h>
27 
28 namespace gr {
29  namespace iridium {
30 
31  /*!
32  * \brief <+description of block+>
33  * \ingroup iridium
34  *
35  */
36  class IRIDIUM_TOOLKIT_API tagged_burst_to_pdu : virtual public gr::sync_block
37  {
38  public:
39  typedef boost::shared_ptr<tagged_burst_to_pdu> sptr;
40 
41  /*!
42  * \brief Return a shared_ptr to a new instance of iridium::tagged_burst_to_pdu.
43  *
44  * To avoid accidental use of raw pointers, iridium::tagged_burst_to_pdu's
45  * constructor is in a private implementation
46  * class. iridium::tagged_burst_to_pdu::make is the public interface for
47  * creating new instances.
48  */
49  static sptr make(int max_burst_size, float relative_center_frequency, float relative_span,
50  float d_relative_sample_rate, int outstanding_limit, bool drop_overflow);
51 
52  virtual uint64_t get_n_dropped_bursts() = 0;
53  virtual int get_output_queue_size() = 0;
54  virtual int get_output_max_queue_size() = 0;
55 
56  };
57 
58  } // namespace iridium
59 } // namespace gr
60 
61 #endif /* INCLUDED_IRIDIUM_TOOLKIT_TAGGED_BURST_TO_PDU_H */
62 
boost::shared_ptr< tagged_burst_to_pdu > sptr
Definition: tagged_burst_to_pdu.h:39
#define IRIDIUM_TOOLKIT_API
Definition: api.h:30
<+description of block+>
Definition: tagged_burst_to_pdu.h:36