Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 3f49d0b75b36c5f9c95c093ed4bd7978 > files > 5761

gnuradio-doc-3.2.2-11.fc15.i686.rpm

<!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"/>
<title>GNU Radio 3.2.2 C++ API: Miscellaneous</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<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.2.2 C++ API</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('group__misc.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<h1>Miscellaneous</h1>  </div>
</div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__goertzel.html">gri_goertzel</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements Goertzel single-bin DFT calculation.  <a href="classgri__goertzel.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__feval__dd.html">gr_feval_dd</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">base class for evaluating a function: double -&gt; doubleThis class is designed to be subclassed in Python or C++ and is callable from both places. It uses SWIG's "director" feature to implement the magic. It's slow. Don't use it in a performance critical path.  <a href="classgr__feval__dd.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__feval__cc.html">gr_feval_cc</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">base class for evaluating a function: complex -&gt; complexThis class is designed to be subclassed in Python or C++ and is callable from both places. It uses SWIG's "director" feature to implement the magic. It's slow. Don't use it in a performance critical path.  <a href="classgr__feval__cc.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__feval__ll.html">gr_feval_ll</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">base class for evaluating a function: long -&gt; longThis class is designed to be subclassed in Python or C++ and is callable from both places. It uses SWIG's "director" feature to implement the magic. It's slow. Don't use it in a performance critical path.  <a href="classgr__feval__ll.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__feval.html">gr_feval</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">base class for evaluating a function: void -&gt; voidThis class is designed to be subclassed in Python or C++ and is callable from both places. It uses SWIG's "director" feature to implement the magic. It's slow. Don't use it in a performance critical path.  <a href="classgr__feval.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fxpt.html">gr_fxpt</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">fixed point sine and cosine and friends.fixed pt radians --------- -------- -2**31 -pi 0 0 2**31-1 pi - epsilon  <a href="classgr__fxpt.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fxpt__nco.html">gr_fxpt_nco</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Numerically Controlled Oscillator (NCO)  <a href="classgr__fxpt__nco.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__fxpt__vco.html">gr_fxpt_vco</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Voltage Controlled Oscillator (VCO)  <a href="classgr__fxpt__vco.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__nco.html">gr_nco&lt; o_type, i_type &gt;</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">base class template for Numerically Controlled Oscillator (NCO)  <a href="classgr__nco.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__prefs.html">gr_prefs</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Base class for representing user preferences a la windows INI files.The real implementation is in Python, and is accessable from C++ via the magic of SWIG directors.  <a href="classgr__prefs.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__test.html">gr_test</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Test class for testing runtime system (setting up buffers and such.)This block does not do any usefull actual data processing. It just exposes setting all standard block parameters using the contructor or public methods.  <a href="classgr__test.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vco.html">gr_vco&lt; o_type, i_type &gt;</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">base class template for Voltage Controlled Oscillator (VCO)  <a href="classgr__vco.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__fft__complex.html">gri_fft_complex</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">FFT: complex in, complex out.  <a href="classgri__fft__complex.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__fft__real__fwd.html">gri_fft_real_fwd</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">FFT: real in, complex out.  <a href="classgri__fft__real__fwd.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__fft__real__rev.html">gri_fft_real_rev</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">FFT: complex in, float out.  <a href="classgri__fft__real__rev.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__glfsr.html">gri_glfsr</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Galois Linear Feedback Shift Register using specified polynomial maskGenerates a maximal length pseudo-random sequence of length 2^degree-1.  <a href="classgri__glfsr.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__lfsr.html">gri_lfsr</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Fibonacci Linear Feedback Shift Register using specified polynomial maskGenerates a maximal length pseudo-random sequence of length 2^degree-1.  <a href="classgri__lfsr.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__lfsr__15__1__0.html">gri_lfsr_15_1_0</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Linear Feedback Shift Register using primitive polynomial x^15 + x + 1Generates a maximal length pseudo-random sequence of length 2^15 - 1 bits.  <a href="classgri__lfsr__15__1__0.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgri__lfsr__32k.html">gri_lfsr_32k</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">generate pseudo-random sequence of length 32768 bits.This is based on <a class="el" href="classgri__lfsr__15__1__0.html" title="Linear Feedback Shift Register using primitive polynomial x^15 + x + 1Generates a maximal length pseu...">gri_lfsr_15_1_0</a> with an extra 0 added at the end of the sequence.  <a href="classgri__lfsr__32k.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__message.html">gr_message</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Message class.  <a href="classgr__message.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__msg__queue.html">gr_msg_queue</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">thread-safe message queue  <a href="classgr__msg__queue.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#gae618d7f851fdb9e2e0a5abc404010043">gr_update_crc32</a> (unsigned int crc, const unsigned char *buf, size_t len)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">update running CRC-32Update a running CRC with the bytes buf[0..len-1] The CRC should be initialized to all 1's, and the transmitted value is the 1's complement of the final running CRC. The resulting CRC should be transmitted in big endian order.  <a href="#gae618d7f851fdb9e2e0a5abc404010043"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#ga7934920e9dbe8204309c2fd68dce8e1c">gr_fast_atan2f</a> (float y, float x)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast arc tangent using table lookup and linear interpolation.  <a href="#ga7934920e9dbe8204309c2fd68dce8e1c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gr__realtime_8h.html#a37b8bb23e68a45e726f6e9a4a8818375">gr_rt_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#ga8ea5c94b1e483b1de195f1494d2dffa7">gr_enable_realtime_scheduling</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">If possible, enable high-priority "real time" scheduling.  <a href="#ga8ea5c94b1e483b1de195f1494d2dffa7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_timer_sptr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#ga54c4024986ca4db5b59761ae5c15ccbe">gr_make_timer</a> (<a class="el" href="gr__timer_8h.html#aaad1a7988cefaef6f86f25ce635e6162">gr_timer_hook</a>, void *)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">create a timeout.  <a href="#ga54c4024986ca4db5b59761ae5c15ccbe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">rt_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__misc.html#gadde7fc3925a3b1f5c919523740281728">gruel::enable_realtime_scheduling</a> (rt_sched_param=rt_sched_param())</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">If possible, enable "realtime" scheduling.In general, this means that the code will be scheduled before any non-realtime (normal) processes. Note that if your code contains an non-blocking infinite loop and you enable realtime scheduling, it's possible to hang the system.  <a href="#gadde7fc3925a3b1f5c919523740281728"></a><br/></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gadde7fc3925a3b1f5c919523740281728"></a><!-- doxytag: member="gruel::enable_realtime_scheduling" ref="gadde7fc3925a3b1f5c919523740281728" args="(rt_sched_param=rt_sched_param())" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">rt_status_t gruel::enable_realtime_scheduling </td>
          <td>(</td>
          <td class="paramtype">rt_sched_param&#160;</td>
          <td class="paramname"> = <code>rt_sched_param()</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>If possible, enable "realtime" scheduling.In general, this means that the code will be scheduled before any non-realtime (normal) processes. Note that if your code contains an non-blocking infinite loop and you enable realtime scheduling, it's possible to hang the system. </p>

</div>
</div>
<a class="anchor" id="ga8ea5c94b1e483b1de195f1494d2dffa7"></a><!-- doxytag: member="gr_realtime.h::gr_enable_realtime_scheduling" ref="ga8ea5c94b1e483b1de195f1494d2dffa7" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="gr__realtime_8h.html#a37b8bb23e68a45e726f6e9a4a8818375">gr_rt_status_t</a> gr_enable_realtime_scheduling </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>If possible, enable high-priority "real time" scheduling. </p>

</div>
</div>
<a class="anchor" id="ga7934920e9dbe8204309c2fd68dce8e1c"></a><!-- doxytag: member="gr_math.h::gr_fast_atan2f" ref="ga7934920e9dbe8204309c2fd68dce8e1c" args="(float y, float x)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float gr_fast_atan2f </td>
          <td>(</td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>x</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Fast arc tangent using table lookup and linear interpolation. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">y</td><td>component of input vector </td></tr>
    <tr><td class="paramname">x</td><td>component of input vector </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>float angle angle of vector (x, y) in radians</dd></dl>
<p>This function calculates the angle of the vector (x,y) based on a table lookup and linear interpolation. The table uses a 256 point table covering -45 to +45 degrees and uses symetry to determine the final angle value in the range of -180 to 180 degrees. Note that this function uses the small angle approximation for values close to zero. This routine calculates the arc tangent with an average error of +/- 0.045 degrees. </p>

<p>Referenced by <a class="el" href="gr__math_8h.html#ae51b150b5480dc16864d7a9c128d4e2b">gr_fast_atan2f()</a>.</p>

</div>
</div>
<a class="anchor" id="ga54c4024986ca4db5b59761ae5c15ccbe"></a><!-- doxytag: member="gr_timer.h::gr_make_timer" ref="ga54c4024986ca4db5b59761ae5c15ccbe" args="(gr_timer_hook, void *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_timer_sptr</a> gr_make_timer </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="gr__timer_8h.html#aaad1a7988cefaef6f86f25ce635e6162">gr_timer_hook</a>&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>create a timeout. </p>
<p>gr_timer_hook is called when timer fires. </p>

</div>
</div>
<a class="anchor" id="gae618d7f851fdb9e2e0a5abc404010043"></a><!-- doxytag: member="gr_crc32.h::gr_update_crc32" ref="gae618d7f851fdb9e2e0a5abc404010043" args="(unsigned int crc, const unsigned char *buf, size_t len)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int gr_update_crc32 </td>
          <td>(</td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>crc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const unsigned char *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>len</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>update running CRC-32Update a running CRC with the bytes buf[0..len-1] The CRC should be initialized to all 1's, and the transmitted value is the 1's complement of the final running CRC. The resulting CRC should be transmitted in big endian order. </p>

</div>
</div>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
    </ul>
  </div>

</body>
</html>