<!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_framer_sink_1 Class Reference</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('classgr__framer__sink__1.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<h1>gr_framer_sink_1 Class Reference<div class="ingroups"><a class="el" href="group__sink__blk.html">Signal Sinks</a></div></h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="gr_framer_sink_1" --><!-- doxytag: inherits="gr_sync_block" -->
<p>Given a stream of bits and access_code flags, assemble packets.input: stream of bytes from <a class="el" href="classgr__correlate__access__code__bb.html" title="Examine input for specified access code, one bit at a time.input: stream of bits, 1 bit per input byt...">gr_correlate_access_code_bb</a> output: none. Pushes assembled packet into target queue.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__framer__sink__1_8h_source.html">gr_framer_sink_1.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_framer_sink_1:</div>
<div class="dyncontent">
<div class="center"><img src="classgr__framer__sink__1__inherit__graph.png" border="0" usemap="#gr__framer__sink__1_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__framer__sink__1_inherit__map" id="gr__framer__sink__1_inherit__map">
<area shape="rect" id="node2" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa..." alt="" coords="13,160,120,189"/><area shape="rect" id="node4" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing flow is cons..." alt="" coords="32,83,101,112"/><area shape="rect" id="node6" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare abstraction of an ..." alt="" coords="12,5,121,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__framer__sink__1-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__framer__sink__1.html#a0be4776f164eaf5a7593b2fc773d7991">~gr_framer_sink_1</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__framer__sink__1.html#aec0600ab0fbe296c5dc83f9ad39a4344">work</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">just like <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you <a href="#aec0600ab0fbe296c5dc83f9ad39a4344"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__framer__sink__1.html#a8462ea2bad2d49086220c2b5eb894805">gr_framer_sink_1</a> (<a class="el" href="classboost_1_1shared__ptr.html">gr_msg_queue_sptr</a> target_queue)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__framer__sink__1.html#ae6506c6d757bfee229e2caf7eeaef1dc">enter_search</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__framer__sink__1.html#ae4c482a3ab679642356620f0c216465b">enter_have_sync</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__framer__sink__1.html#ad4215dba4e9dcff8b7ed24615b334875">enter_have_header</a> (int payload_len, int whitener_offset)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__framer__sink__1.html#a25b0dab75810602a2f50e734aa2da66b">header_ok</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__framer__sink__1.html#a797381f43858bf0745cc268442ef39b4">header_payload</a> (int *len, int *offset)</td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_framer_sink_1_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__framer__sink__1.html#a4fb6b2ccea5f7c7f4fe9a04e005b09e2">gr_make_framer_sink_1</a> (<a class="el" href="classboost_1_1shared__ptr.html">gr_msg_queue_sptr</a> target_queue)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Given a stream of bits and access_code flags, assemble packets.</p>
<p>input: stream of bytes from <a class="el" href="classgr__correlate__access__code__bb.html" title="Examine input for specified access code, one bit at a time.input: stream of bits, 1 bit per input byt...">gr_correlate_access_code_bb</a> output: none. Pushes assembled packet into target queue. </p>
<p>The framer expects a fixed length header of 2 16-bit shorts containing the payload length, followed by the payload. If the 2 16-bit shorts are not identical, this packet is ignored. Better algs are welcome.</p>
<p>The input data consists of bytes that have two bits used. Bit 0, the LSB, contains the data bit. Bit 1 if set, indicates that the corresponding bit is the the first bit of the packet. That is, this bit is the first one after the access code. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8462ea2bad2d49086220c2b5eb894805"></a><!-- doxytag: member="gr_framer_sink_1::gr_framer_sink_1" ref="a8462ea2bad2d49086220c2b5eb894805" args="(gr_msg_queue_sptr target_queue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_framer_sink_1::gr_framer_sink_1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_msg_queue_sptr</a> </td>
<td class="paramname"><em>target_queue</em></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0be4776f164eaf5a7593b2fc773d7991"></a><!-- doxytag: member="gr_framer_sink_1::~gr_framer_sink_1" ref="a0be4776f164eaf5a7593b2fc773d7991" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_framer_sink_1::~gr_framer_sink_1 </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad4215dba4e9dcff8b7ed24615b334875"></a><!-- doxytag: member="gr_framer_sink_1::enter_have_header" ref="ad4215dba4e9dcff8b7ed24615b334875" args="(int payload_len, int whitener_offset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_framer_sink_1::enter_have_header </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>payload_len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>whitener_offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae4c482a3ab679642356620f0c216465b"></a><!-- doxytag: member="gr_framer_sink_1::enter_have_sync" ref="ae4c482a3ab679642356620f0c216465b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_framer_sink_1::enter_have_sync </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae6506c6d757bfee229e2caf7eeaef1dc"></a><!-- doxytag: member="gr_framer_sink_1::enter_search" ref="ae6506c6d757bfee229e2caf7eeaef1dc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_framer_sink_1::enter_search </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a25b0dab75810602a2f50e734aa2da66b"></a><!-- doxytag: member="gr_framer_sink_1::header_ok" ref="a25b0dab75810602a2f50e734aa2da66b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> gr_framer_sink_1::header_ok </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a797381f43858bf0745cc268442ef39b4"></a><!-- doxytag: member="gr_framer_sink_1::header_payload" ref="a797381f43858bf0745cc268442ef39b4" args="(int *len, int *offset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_framer_sink_1::header_payload </td>
<td>(</td>
<td class="paramtype">int * </td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aec0600ab0fbe296c5dc83f9ad39a4344"></a><!-- doxytag: member="gr_framer_sink_1::work" ref="aec0600ab0fbe296c5dc83f9ad39a4344" args="(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_framer_sink_1::work </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>noutput_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> & </td>
<td class="paramname"><em>input_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> & </td>
<td class="paramname"><em>output_items</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>just like <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you </p>
<p>The user must override work to define the signal processing code </p>
<p>Implements <a class="el" href="classgr__sync__block.html#a0c523f4285a6eb690f677ee6295ab117">gr_sync_block</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a4fb6b2ccea5f7c7f4fe9a04e005b09e2"></a><!-- doxytag: member="gr_framer_sink_1::gr_make_framer_sink_1" ref="a4fb6b2ccea5f7c7f4fe9a04e005b09e2" args="(gr_msg_queue_sptr target_queue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_framer_sink_1_sptr</a> gr_make_framer_sink_1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_msg_queue_sptr</a> </td>
<td class="paramname"><em>target_queue</em></td><td>)</td>
<td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gr__framer__sink__1_8h_source.html">gr_framer_sink_1.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classgr__framer__sink__1.html">gr_framer_sink_1</a> </li>
<li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by 
<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>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
1276
