<!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_correlate_access_code_bb 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.2 -->
<div class="contents">
<h1>gr_correlate_access_code_bb Class Reference<br/>
<small>
[<a class="el" href="group__sync__blk.html">Synchronization</a>]</small>
</h1><!-- doxytag: class="gr_correlate_access_code_bb" --><!-- doxytag: inherits="gr_sync_block" -->
<p>Examine input for specified access code, one bit at a time.input: stream of bits, 1 bit per input byte (data in LSB) output: stream of bits, 2 bits per output byte (data in LSB, flag in next higher bit).
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__correlate__access__code__bb_8h_source.html">gr_correlate_access_code_bb.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_correlate_access_code_bb:</div>
<div class="dynsection">
<div class="center"><img src="classgr__correlate__access__code__bb__inherit__graph.png" border="0" usemap="#gr__correlate__access__code__bb_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__correlate__access__code__bb_inherit__map" id="gr__correlate__access__code__bb_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="49,160,156,189"/><area shape="rect" id="node4" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing..." alt="" coords="68,83,137,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..." alt="" coords="48,5,157,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__correlate__access__code__bb-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__correlate__access__code__bb.html#a5a391df9b045899fbc8e3fa4407732c3">~gr_correlate_access_code_bb</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__correlate__access__code__bb.html#ae23546d9652cf57f696b42a567cecbf6">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="#ae23546d9652cf57f696b42a567cecbf6"></a><br/></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__correlate__access__code__bb.html#a1d2afcb9436001e63b28324021848bfe">set_access_code</a> (const std::string &access_code)</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__correlate__access__code__bb.html#aa33e088c9248f47a3de9620aa26cb6e1">gr_correlate_access_code_bb</a> (const std::string &access_code, int threshold)</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_correlate_access_code_bb_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__correlate__access__code__bb.html#a241d4a6ca3c0e07cca1a1d16d585435c">gr_make_correlate_access_code_bb</a> (const std::string &access_code, int threshold)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Examine input for specified access code, one bit at a time.</p>
<p>input: stream of bits, 1 bit per input byte (data in LSB) output: stream of bits, 2 bits per output byte (data in LSB, flag in next higher bit). </p>
<p>Each output byte contains two valid bits, the data bit, and the flag bit. The LSB (bit 0) is the data bit, and is the original input data, delayed 64 bits. Bit 1 is the flag bit and is 1 if the corresponding data bit is the first data bit following the access code. Otherwise the flag bit is 0. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa33e088c9248f47a3de9620aa26cb6e1"></a><!-- doxytag: member="gr_correlate_access_code_bb::gr_correlate_access_code_bb" ref="aa33e088c9248f47a3de9620aa26cb6e1" args="(const std::string &access_code, int threshold)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_correlate_access_code_bb::gr_correlate_access_code_bb </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>access_code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>threshold</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="a5a391df9b045899fbc8e3fa4407732c3"></a><!-- doxytag: member="gr_correlate_access_code_bb::~gr_correlate_access_code_bb" ref="a5a391df9b045899fbc8e3fa4407732c3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_correlate_access_code_bb::~gr_correlate_access_code_bb </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="a1d2afcb9436001e63b28324021848bfe"></a><!-- doxytag: member="gr_correlate_access_code_bb::set_access_code" ref="a1d2afcb9436001e63b28324021848bfe" args="(const std::string &access_code)" -->
<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_correlate_access_code_bb::set_access_code </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>access_code</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>access_code</em> </td><td>is represented with 1 byte per bit, e.g., "010101010111000100" </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae23546d9652cf57f696b42a567cecbf6"></a><!-- doxytag: member="gr_correlate_access_code_bb::work" ref="ae23546d9652cf57f696b42a567cecbf6" 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_correlate_access_code_bb::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="a241d4a6ca3c0e07cca1a1d16d585435c"></a><!-- doxytag: member="gr_correlate_access_code_bb::gr_make_correlate_access_code_bb" ref="a241d4a6ca3c0e07cca1a1d16d585435c" args="(const std::string &access_code, int threshold)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_correlate_access_code_bb_sptr</a> gr_make_correlate_access_code_bb </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>access_code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>threshold</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>access_code</em> </td><td>is represented with 1 byte per bit, e.g., "010101010111000100" </td></tr>
<tr><td valign="top"></td><td valign="top"><em>threshold</em> </td><td>maximum number of bits that may be wrong </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gr__correlate__access__code__bb_8h_source.html">gr_correlate_access_code_bb.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>
