<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.3"/> <title>GNU Radio 3.6.4.1 C++ API: gr_pll_refout_cc.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">GNU Radio 3.6.4.1 C++ API </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3 --> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('gr__pll__refout__cc_8h_source.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <div class="title">gr_pll_refout_cc.h</div> </div> </div><!--header--> <div class="contents"> <a href="gr__pll__refout__cc_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* -*- c++ -*- */</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2004,2011 Free Software Foundation, Inc.</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This file is part of GNU Radio</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * it under the terms of the GNU General Public License as published by</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * any later version.</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * GNU General Public License for more details.</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * You should have received a copy of the GNU General Public License</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * Boston, MA 02110-1301, USA.</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef INCLUDED_GR_PLL_REFOUT_CC_H</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_PLL_REFOUT_CC_H</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="gr__core__api_8h.html">gr_core_api.h</a>></span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="gr__sync__block_8h.html">gr_sync_block.h</a>></span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <<a class="code" href="gri__control__loop_8h.html">gri_control_loop.h</a>></span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">class </span><a class="code" href="classgr__pll__refout__cc.html" title="Implements a PLL which locks to the input frequency and outputs a carrierinput: stream of complex; ou...">gr_pll_refout_cc</a>;</div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<gr_pll_refout_cc></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_pll_refout_cc_sptr</a>;</div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <a class="code" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_pll_refout_cc_sptr</a> <a class="code" href="gr__pll__refout__cc_8h.html#a6d5109b221a6aab1df9002f167b090bb">gr_make_pll_refout_cc</a> (<span class="keywordtype">float</span> loop_bw,</div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordtype">float</span> max_freq, <span class="keywordtype">float</span> min_freq);<span class="comment"></span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">/*!</span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * \brief Implements a PLL which locks to the input frequency and outputs a carrier</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * \ingroup sync_blk</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> *</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * input: stream of complex; output: stream of complex</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> *</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * This PLL locks onto a [possibly noisy] reference carrier on</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * the input and outputs a clean version which is phase and frequency</span></div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * aligned to it.</span></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> *</span></div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * All settings max_freq and min_freq are in terms of radians per sample,</span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * NOT HERTZ. The loop bandwidth determins the lock range and should be set</span></div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * around pi/200 -- 2pi/100.</span></div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * \sa gr_pll_freqdet_cf, gr_pll_carriertracking_cc</span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> */</span></div> <div class="line"><a name="l00050"></a><span class="lineno"><a class="code" href="classgr__pll__refout__cc.html"> 50</a></span> <span class="keyword">class </span><a class="code" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="code" href="classgr__pll__refout__cc.html" title="Implements a PLL which locks to the input frequency and outputs a carrierinput: stream of complex; ou...">gr_pll_refout_cc</a> : <span class="keyword">public</span> <a class="code" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...">gr_sync_block</a>, <span class="keyword">public</span> <a class="code" href="classgri__control__loop.html">gri_control_loop</a></div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> {</div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">friend</span> <a class="code" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_pll_refout_cc_sptr</a> <a class="code" href="gr__pll__refout__cc_8h.html#a6d5109b221a6aab1df9002f167b090bb">gr_make_pll_refout_cc</a> (<span class="keywordtype">float</span> loop_bw,</div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">float</span> max_freq, <span class="keywordtype">float</span> min_freq);</div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="classgr__pll__refout__cc.html" title="Implements a PLL which locks to the input frequency and outputs a carrierinput: stream of complex; ou...">gr_pll_refout_cc</a> (<span class="keywordtype">float</span> loop_bw, <span class="keywordtype">float</span> max_freq, <span class="keywordtype">float</span> min_freq);</div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">int</span> <a class="code" href="classgr__sync__block.html#a0c523f4285a6eb690f677ee6295ab117" title="just like gr_block::general_work, only this arranges to call consume_each for you">work</a> (<span class="keywordtype">int</span> noutput_items,</div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="gr__types_8h.html#a9852a3d906d823cb70eb9c29e7f2a43d">gr_vector_const_void_star</a> &input_items,</div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="gr__types_8h.html#acd3f499576e769966ea44554b359d949">gr_vector_void_star</a> &output_items);</div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">private</span>:</div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">float</span> mod_2pi (<span class="keywordtype">float</span> in);</div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">float</span> phase_detector(<a class="code" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> sample, <span class="keywordtype">float</span> ref_phase);</div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> };</div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#endif</span></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="dir_284717b6cb06147531c058220802c6d1.html">gnuradio-core</a></li><li class="navelem"><a class="el" href="dir_7c24473031c549da670035bb20d1e97e.html">src</a></li><li class="navelem"><a class="el" href="dir_84906bae47c76101f1fa015cf813f8a2.html">lib</a></li><li class="navelem"><a class="el" href="dir_a82a9d947ffcded01cd668b1a1a6c872.html">general</a></li><li class="navelem"><a class="el" href="gr__pll__refout__cc_8h.html">gr_pll_refout_cc.h</a></li> <li class="footer">Generated on Fri Apr 19 2013 16:20:33 for GNU Radio 3.6.4.1 C++ API by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li> </ul> </div> </body> </html>