GNU Radio's GSM Package
clock_offset_control.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * @file
4  * @author Piotr Krysik <ptrkrysik@gmail.com>
5  * @section LICENSE
6  *
7  * Gr-gsm 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  * Gr-gsm 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 gr-gsm; 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 
24 
25 #ifndef INCLUDED_GSM_CLOCK_OFFSET_CONTROL_H
26 #define INCLUDED_GSM_CLOCK_OFFSET_CONTROL_H
27 
28 #include <grgsm/api.h>
29 #include <gnuradio/block.h>
30 
31 namespace gr {
32  namespace gsm {
33 
34  /*!
35  * \brief <+description of block+>
36  * \ingroup gsm
37  *
38  */
39  class GRGSM_API clock_offset_control : virtual public gr::block
40  {
41  public:
42  typedef boost::shared_ptr<clock_offset_control> sptr;
43 
44  /*!
45  * \brief Return a shared_ptr to a new instance of gsm::clock_offset_control.
46  *
47  * To avoid accidental use of raw pointers, gsm::clock_offset_control's
48  * constructor is in a private implementation
49  * class. gsm::clock_offset_control::make is the public interface for
50  * creating new instances.
51  */
52  static sptr make(float fc);
53  virtual void set_fc(float fc) = 0;
54  };
55 
56  } // namespace gsm
57 } // namespace gr
58 
59 #endif /* INCLUDED_GSM_CLOCK_OFFSET_CONTROL_H */
60 
boost::shared_ptr< clock_offset_control > sptr
Definition: clock_offset_control.h:42
#define GRGSM_API
Definition: api.h:31
&lt;+description of block+&gt;
Definition: clock_offset_control.h:39