Imported Upstream version 3.2.2
[debian/gnuradio] / usrp2 / host / include / usrp2 / tune_result.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2008 Free Software Foundation, Inc.
4  *
5  * This program 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 of the License, or
8  * (at your option) any later version.
9  *
10  * This program 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 program.  If not, see <http://www.gnu.org/licenses/>.
17  */
18
19 #ifndef INCLUDED_USRP2_TUNE_RESULT_H
20 #define INCLUDED_USRP2_TUNE_RESULT_H
21
22 namespace usrp2 {
23
24   /*
25    * \ingroup usrp2
26    */
27   class tune_result
28   {
29   public:
30     // RF frequency that corresponds to DC in the IF
31     double baseband_freq;
32
33     // frequency programmed into the DDC/DUC
34     double dxc_freq;
35
36     // residual frequency (typically < 0.01 Hz)
37     double residual_freq;
38
39     // is the spectrum inverted?
40     bool spectrum_inverted;
41
42     tune_result(double baseband=0, double dxc=0, double residual=0, bool inverted=false)
43       : baseband_freq(baseband), dxc_freq(dxc),
44         residual_freq(residual), spectrum_inverted(inverted) {}
45   };
46
47 } // namespace usrp2
48
49 #endif /* INCLUDED_USRP2_TUNE_RESULT_H */