GNU Radio 3.6.4.1 C++ API
microtune_xxxx.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2001,2003,2004 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_MICROTUNE_XXXX_H
24 #define INCLUDED_MICROTUNE_XXXX_H
25 
26 #include <gr_core_api.h>
27 #include <boost/shared_ptr.hpp>
28 
29 class i2c;
31 
32 /*!
33  * \brief abstract class for controlling microtune {4937,4702} tuner modules
34  * \ingroup base
35  */
37 public:
39  virtual ~microtune_xxxx ();
40 
41  /*!
42  * \brief select RF frequency to be tuned to output frequency.
43  * \p freq is the requested frequency in Hz, \p actual_freq
44  * is set to the actual frequency tuned. It takes about 100 ms
45  * for the PLL to settle.
46  *
47  * \returns true iff sucessful.
48  */
49  virtual bool set_RF_freq (double freq, double *actual_freq) = 0;
50 
51  // returns actual freq or 0 if error (easier interface for SWIG)
52  double set_RF_freq (double freq);
53 
54  /*!
55  * \returns true iff PLL is locked
56  */
57  virtual bool pll_locked_p () = 0;
58 
59  /*!
60  * \returns the output frequency (IF center freq) of the tuner in Hz.
61  */
62  virtual double get_output_freq () = 0;
63 
64 };
65 
66 #endif /* INCLUDED_MICROTUNE_XXXX_H */