Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 4909

gnuradio-doc-3.2.2-9.fc14.x86_64.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: gr_packet_sink.h Source File</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('gr__packet__sink_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<h1>gr_packet_sink.h</h1>  </div>
</div>
<div class="contents">
<a href="gr__packet__sink_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2005 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING.  If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022 
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef INCLUDED_GR_PACKET_SINK_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_PACKET_SINK_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;gr_sync_block.h&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;gr_msg_queue.h&gt;</span>
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="keyword">class </span><a class="code" href="classgr__packet__sink.html" title="process received bits looking for packet sync, header, and process bits into packet">gr_packet_sink</a>;
<a name="l00030"></a>00030 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr&lt;gr_packet_sink&gt;</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_packet_sink_sptr</a>;
<a name="l00031"></a>00031 
<a name="l00032"></a>00032 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_packet_sink_sptr</a> 
<a name="l00033"></a>00033 <a class="code" href="gr__packet__sink_8h.html#a7940ff43dcaa8e48aa973208be56504b">gr_make_packet_sink</a> (<span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;unsigned char&gt;</a>&amp; sync_vector,
<a name="l00034"></a>00034                      <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_msg_queue_sptr</a> target_queue,
<a name="l00035"></a>00035                      <span class="keywordtype">int</span> threshold = -1                 <span class="comment">// -1 -&gt; use default</span>
<a name="l00036"></a>00036                      );<span class="comment"></span>
<a name="l00037"></a>00037 <span class="comment">/*!</span>
<a name="l00038"></a>00038 <span class="comment"> * \brief process received  bits looking for packet sync, header, and process bits into packet</span>
<a name="l00039"></a>00039 <span class="comment"> * \ingroup sink_blk</span>
<a name="l00040"></a>00040 <span class="comment"> */</span>
<a name="l00041"></a><a class="code" href="classgr__packet__sink.html">00041</a> <span class="keyword">class </span><a class="code" href="classgr__packet__sink.html" title="process received bits looking for packet sync, header, and process bits into packet">gr_packet_sink</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>
<a name="l00042"></a>00042 {
<a name="l00043"></a>00043   <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_packet_sink_sptr</a> 
<a name="l00044"></a>00044   <a class="code" href="classgr__packet__sink.html#a011d6a76fc380c53c7a663d693e74b2f">gr_make_packet_sink</a> (<span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;unsigned char&gt;</a>&amp; sync_vector,
<a name="l00045"></a>00045                        <a class="code" href="classboost_1_1shared__ptr.html">gr_msg_queue_sptr</a> target_queue,
<a name="l00046"></a>00046                        <span class="keywordtype">int</span> threshold);
<a name="l00047"></a>00047 
<a name="l00048"></a>00048  <span class="keyword">private</span>:
<a name="l00049"></a>00049   <span class="keyword">enum</span> state_t {STATE_SYNC_SEARCH, STATE_HAVE_SYNC, STATE_HAVE_HEADER};
<a name="l00050"></a>00050 
<a name="l00051"></a>00051   <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> MAX_PKT_LEN    = 4096;
<a name="l00052"></a>00052   <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> HEADERBITLEN   = 32;
<a name="l00053"></a>00053 
<a name="l00054"></a>00054   <a class="code" href="classboost_1_1shared__ptr.html">gr_msg_queue_sptr</a>  d_target_queue;            <span class="comment">// where to send the packet when received</span>
<a name="l00055"></a>00055   <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> d_sync_vector;             <span class="comment">// access code to locate start of packet</span>
<a name="l00056"></a>00056   <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>       d_threshold;               <span class="comment">// how many bits may be wrong in sync vector</span>
<a name="l00057"></a>00057 
<a name="l00058"></a>00058   state_t            d_state;
<a name="l00059"></a>00059 
<a name="l00060"></a>00060   <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> d_shift_reg;               <span class="comment">// used to look for sync_vector</span>
<a name="l00061"></a>00061 
<a name="l00062"></a>00062   <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>       d_header;                  <span class="comment">// header bits</span>
<a name="l00063"></a>00063   <span class="keywordtype">int</span>                d_headerbitlen_cnt;        <span class="comment">// how many so far</span>
<a name="l00064"></a>00064 
<a name="l00065"></a>00065   <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>      d_packet[MAX_PKT_LEN];     <span class="comment">// assembled payload</span>
<a name="l00066"></a>00066   <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>      d_packet_byte;             <span class="comment">// byte being assembled</span>
<a name="l00067"></a>00067   <span class="keywordtype">int</span>                d_packet_byte_index;       <span class="comment">// which bit of d_packet_byte we&#39;re working on</span>
<a name="l00068"></a>00068   <span class="keywordtype">int</span>                d_packetlen;               <span class="comment">// length of packet</span>
<a name="l00069"></a>00069   <span class="keywordtype">int</span>                d_packetlen_cnt;           <span class="comment">// how many so far</span>
<a name="l00070"></a>00070 
<a name="l00071"></a>00071  <span class="keyword">protected</span>:
<a name="l00072"></a>00072   <a class="code" href="classgr__packet__sink.html#aca3162215b64abe275567f55fd7533d0">gr_packet_sink</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;unsigned char&gt;</a>&amp; sync_vector, 
<a name="l00073"></a>00073                  <a class="code" href="classboost_1_1shared__ptr.html">gr_msg_queue_sptr</a> target_queue,
<a name="l00074"></a>00074                  <span class="keywordtype">int</span> threshold);
<a name="l00075"></a>00075 
<a name="l00076"></a>00076   <span class="keywordtype">void</span> <a class="code" href="classgr__packet__sink.html#a51919fbafd2e9e6d57e08e37c79852cb">enter_search</a>();
<a name="l00077"></a>00077   <span class="keywordtype">void</span> <a class="code" href="classgr__packet__sink.html#a7479c5de3faa20374784d735b100120f">enter_have_sync</a>();
<a name="l00078"></a>00078   <span class="keywordtype">void</span> <a class="code" href="classgr__packet__sink.html#accc43f02145a1f6b3375a62630bcd533">enter_have_header</a>(<span class="keywordtype">int</span> payload_len);
<a name="l00079"></a>00079   
<a name="l00080"></a><a class="code" href="classgr__packet__sink.html#aed0e4f3003504d421ea816c7c0237a74">00080</a>   <span class="keywordtype">int</span> <a class="code" href="classgr__packet__sink.html#aed0e4f3003504d421ea816c7c0237a74">slice</a>(<span class="keywordtype">float</span> x) { <span class="keywordflow">return</span> x &gt; 0 ? 1 : 0; }
<a name="l00081"></a>00081 
<a name="l00082"></a><a class="code" href="classgr__packet__sink.html#a8113a705c44649c925447ced61fb4c67">00082</a>   <span class="keywordtype">bool</span> <a class="code" href="classgr__packet__sink.html#a8113a705c44649c925447ced61fb4c67">header_ok</a>()
<a name="l00083"></a>00083   {
<a name="l00084"></a>00084     <span class="comment">// confirm that two copies of header info are identical</span>
<a name="l00085"></a>00085     <span class="keywordflow">return</span> ((d_header &gt;&gt; 16) ^ (d_header &amp; 0xffff)) == 0;
<a name="l00086"></a>00086   }
<a name="l00087"></a>00087 
<a name="l00088"></a><a class="code" href="classgr__packet__sink.html#a626be5e11e812b81a7c3670770a94234">00088</a>   <span class="keywordtype">int</span> <a class="code" href="classgr__packet__sink.html#a626be5e11e812b81a7c3670770a94234">header_payload_len</a>()
<a name="l00089"></a>00089   {
<a name="l00090"></a>00090     <span class="comment">// header consists of two 16-bit shorts in network byte order</span>
<a name="l00091"></a>00091     <span class="keywordtype">int</span> t = (d_header &gt;&gt; 16) &amp; 0xffff;
<a name="l00092"></a>00092     <span class="keywordflow">return</span> t;
<a name="l00093"></a>00093   }
<a name="l00094"></a>00094 
<a name="l00095"></a>00095  <span class="keyword">public</span>:
<a name="l00096"></a>00096   <a class="code" href="classgr__packet__sink.html#a7ce964ea98fb65ca99d6d8c605ec14e7">~gr_packet_sink</a>();
<a name="l00097"></a>00097 
<a name="l00098"></a>00098   <span class="keywordtype">int</span> <a class="code" href="classgr__packet__sink.html#a935f2f31a4bb191cdc40a7e890248d24" 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,
<a name="l00099"></a>00099            <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &amp;input_items,
<a name="l00100"></a>00100            <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &amp;output_items);
<a name="l00101"></a>00101 
<a name="l00102"></a>00102 <span class="comment"></span>
<a name="l00103"></a>00103 <span class="comment">  //! return true if we detect carrier</span>
<a name="l00104"></a><a class="code" href="classgr__packet__sink.html#a1973dc6af65d665e487f9e8a7d9d4c1e">00104</a> <span class="comment"></span>  <span class="keywordtype">bool</span> <a class="code" href="classgr__packet__sink.html#a1973dc6af65d665e487f9e8a7d9d4c1e" title="return true if we detect carrier">carrier_sensed</a>()<span class="keyword"> const</span>
<a name="l00105"></a>00105 <span class="keyword">  </span>{
<a name="l00106"></a>00106     <span class="keywordflow">return</span> d_state != STATE_SYNC_SEARCH;
<a name="l00107"></a>00107   }
<a name="l00108"></a>00108 
<a name="l00109"></a>00109 };
<a name="l00110"></a>00110 
<a name="l00111"></a>00111 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GR_PACKET_SINK_H */</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="gr__packet__sink_8h.html">gr_packet_sink.h</a>      </li>
      <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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional