<!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.3.0 C++ API: gr_framer_sink_1 Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.3 --> <div class="contents"> <h1>gr_framer_sink_1 Class Reference<br/> <small> [<a class="el" href="group__sink__blk.html">Signal Sinks</a>]</small> </h1><!-- 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...">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="dynsection"> <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..." alt="" coords="21,315,128,344"/><area shape="rect" id="node4" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing..." alt="" coords="40,237,109,267"/><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..." alt="" coords="20,160,129,189"/><area shape="rect" id="node8" href="classgr__msg__accepter.html" title="Accepts messages and inserts them into a message queue, then notifies subclass gr_basic_block..." alt="" coords="13,83,136,112"/><area shape="rect" id="node10" href="classgruel_1_1msg__accepter.html" title="Virtual base class that accepts messages." alt="" coords="5,5,144,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 border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>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>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>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> <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...">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> <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><td> </td> </tr> <tr> <td></td> <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><td> </td> </tr> <tr> <td></td> <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><td> </td> </tr> <tr> <td></td> <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> <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:52:46 2010 for GNU Radio 3.3.0 C++ API by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>