GNU Radio's BLOCKSTREAM Package
runtime_cfo_ctrl.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2017 <+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_BLOCKSAT_RUNTIME_CFO_CTRL_H
23 #define INCLUDED_BLOCKSAT_RUNTIME_CFO_CTRL_H
24 
25 #include <blocksat/api.h>
26 #include <gnuradio/sync_block.h>
27 
28 namespace gr {
29  namespace blocksat {
30 
31  /*!
32  * \brief <+description of block+>
33  * \ingroup blocksat
34  *
35  */
36  class BLOCKSAT_API runtime_cfo_ctrl : virtual public gr::sync_block
37  {
38  public:
39  typedef boost::shared_ptr<runtime_cfo_ctrl> sptr;
40 
41  virtual void set_avg_len(int avg_len) = 0;
42  virtual float get_cfo_estimate() = 0;
43  virtual int get_rf_center_freq() = 0;
44  virtual void set_rf_center_freq(int freq) = 0;
45  virtual int get_cfo_est_state() = 0;
46  /*!
47  * \brief Return a shared_ptr to a new instance of blocksat::runtime_cfo_ctrl.
48  *
49  * To avoid accidental use of raw pointers, blocksat::runtime_cfo_ctrl's
50  * constructor is in a private implementation
51  * class. blocksat::runtime_cfo_ctrl::make is the public interface for
52  * creating new instances.
53  */
54  static sptr make(int avg_len, float abs_cfo_threshold, int rf_center_freq);
55  };
56 
57  } // namespace blocksat
58 } // namespace gr
59 
60 #endif /* INCLUDED_BLOCKSAT_RUNTIME_CFO_CTRL_H */
&lt;+description of block+&gt;
Definition: runtime_cfo_ctrl.h:36
boost::shared_ptr< runtime_cfo_ctrl > sptr
Definition: runtime_cfo_ctrl.h:39
#define BLOCKSAT_API
Definition: api.h:30