Imported Upstream version 3.0.4
[debian/gnuradio] / gnuradio-core / src / lib / io / microtune_xxxx_eval_board.i
1 /* -*- c++ -*- */
2 /*
3  * Copyright 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 class microtune_xxxx_eval_board {
24 public:
25   microtune_xxxx_eval_board (int which_pp = 0);
26   virtual ~microtune_xxxx_eval_board ();
27
28   //! is the eval board present?
29   bool board_present_p ();
30
31   /*!
32    * \brief set RF and IF AGC control voltages ([0, 5] volts)
33    */
34   void set_RF_AGC_voltage (float volts);
35   void set_IF_AGC_voltage (float volts);
36
37   /*!
38    * \brief set RF and IF AGC levels together (scale [0, 1000])
39    *
40    * This provides a simple linear interface for adjusting both
41    * the RF and IF gain in consort.  This is the easy to use interface.
42    * 0 corresponds to minimum gain. 1000 corresponds to maximum gain.
43    */
44   virtual void set_AGC (float value_0_1000) = 0;
45
46   // returns actual freq or 0 if error (easier interface for SWIG)
47   double set_RF_freq (double freq);
48
49   /*!
50    * \returns true iff PLL is locked
51    */
52   bool pll_locked_p ();
53   
54   /*!
55    * \returns the output frequency (IF center freq) of the tuner in Hz.
56    */
57   double get_output_freq ();
58 };