<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>GNU Radio 3.6.4.1 C++ API: gr_pn_correlator_cc Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<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.6.4.1 C++ API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classgr__pn__correlator__cc.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> |
<a href="classgr__pn__correlator__cc-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">gr_pn_correlator_cc Class Reference<div class="ingroups"><a class="el" href="group__sync__blk.html">Synchronization</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>PN code sequential search correlator.
<a href="classgr__pn__correlator__cc.html#details">More...</a></p>
<p><code>#include <<a class="el" href="gr__pn__correlator__cc_8h_source.html">gr_pn_correlator_cc.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_pn_correlator_cc:</div>
<div class="dyncontent">
<div class="center"><img src="classgr__pn__correlator__cc__inherit__graph.png" border="0" usemap="#gr__pn__correlator__cc_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__pn__correlator__cc_inherit__map" id="gr__pn__correlator__cc_inherit__map">
<area shape="rect" id="node2" href="classgr__sync__decimator.html" title="synchronous N:1 input to output with historyOverride work to provide the signal processing implementa..." alt="" coords="87,408,219,435"/><area shape="rect" id="node4" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa..." alt="" coords="100,333,207,360"/><area shape="rect" id="node6" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing flow is constructed ..." alt="" coords="118,259,188,285"/><area shape="rect" id="node8" 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="99,184,208,211"/><area shape="rect" id="node10" href="classgr__msg__accepter.html" title="Accepts messages and inserts them into a message queue, then notifies subclass gr_basic_block there i..." alt="" coords="13,95,136,121"/><area shape="rect" id="node12" href="classgruel_1_1msg__accepter.html" title="Virtual base class that accepts messages." alt="" coords="5,5,144,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a27f4a2a6353c363482ae9dba1eac5cda"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__pn__correlator__cc.html#a27f4a2a6353c363482ae9dba1eac5cda">work</a> (int noutput_items, <a class="el" href="gr__types_8h.html#a9852a3d906d823cb70eb9c29e7f2a43d">gr_vector_const_void_star</a> &input_items, <a class="el" href="gr__types_8h.html#acd3f499576e769966ea44554b359d949">gr_vector_void_star</a> &output_items)</td></tr>
<tr class="memdesc:a27f4a2a6353c363482ae9dba1eac5cda"><td class="mdescLeft"> </td><td class="mdescRight">just like <a class="el" href="classgr__block.html#adf59080d10f322e3816b7ac8f7cb2a7c" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you <a href="#a27f4a2a6353c363482ae9dba1eac5cda"></a><br/></td></tr>
<tr class="separator:a27f4a2a6353c363482ae9dba1eac5cda"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c7e3f34bc9e5895220c4ea874950f96"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__pn__correlator__cc.html#a2c7e3f34bc9e5895220c4ea874950f96">~gr_pn_correlator_cc</a> ()</td></tr>
<tr class="separator:a2c7e3f34bc9e5895220c4ea874950f96"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classgr__sync__decimator"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgr__sync__decimator')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgr__sync__decimator.html">gr_sync_decimator</a></td></tr>
<tr class="memitem:a285a3292be71f47df2e8f10a779eb752 inherit pub_methods_classgr__sync__decimator"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__decimator.html#a285a3292be71f47df2e8f10a779eb752">decimation</a> () const </td></tr>
<tr class="separator:a285a3292be71f47df2e8f10a779eb752 inherit pub_methods_classgr__sync__decimator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ae57c3e625dfaca6487a319c2078a57 inherit pub_methods_classgr__sync__decimator"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__decimator.html#a5ae57c3e625dfaca6487a319c2078a57">set_decimation</a> (unsigned <a class="el" href="classgr__sync__decimator.html#a285a3292be71f47df2e8f10a779eb752">decimation</a>)</td></tr>
<tr class="separator:a5ae57c3e625dfaca6487a319c2078a57 inherit pub_methods_classgr__sync__decimator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a140792c0a9777b6b82eb220cdd424ecd inherit pub_methods_classgr__sync__decimator"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__decimator.html#a140792c0a9777b6b82eb220cdd424ecd">forecast</a> (int noutput_items, <a class="el" href="gr__types_8h.html#ab02d0a829d67d39e3ac3163016d3a8be">gr_vector_int</a> &ninput_items_required)</td></tr>
<tr class="memdesc:a140792c0a9777b6b82eb220cdd424ecd inherit pub_methods_classgr__sync__decimator"><td class="mdescLeft"> </td><td class="mdescRight">Estimate input requirements given output request. <a href="#a140792c0a9777b6b82eb220cdd424ecd"></a><br/></td></tr>
<tr class="separator:a140792c0a9777b6b82eb220cdd424ecd inherit pub_methods_classgr__sync__decimator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a7d9a6487780922c14cbb76d46a0586 inherit pub_methods_classgr__sync__decimator"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__decimator.html#a3a7d9a6487780922c14cbb76d46a0586">general_work</a> (int noutput_items, <a class="el" href="gr__types_8h.html#ab02d0a829d67d39e3ac3163016d3a8be">gr_vector_int</a> &ninput_items, <a class="el" href="gr__types_8h.html#a9852a3d906d823cb70eb9c29e7f2a43d">gr_vector_const_void_star</a> &input_items, <a class="el" href="gr__types_8h.html#acd3f499576e769966ea44554b359d949">gr_vector_void_star</a> &output_items)</td></tr>
<tr class="memdesc:a3a7d9a6487780922c14cbb76d46a0586 inherit pub_methods_classgr__sync__decimator"><td class="mdescLeft"> </td><td class="mdescRight">compute output items from input items <a href="#a3a7d9a6487780922c14cbb76d46a0586"></a><br/></td></tr>
<tr class="separator:a3a7d9a6487780922c14cbb76d46a0586 inherit pub_methods_classgr__sync__decimator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a23c657d3c3f0482369648e1916751f6f inherit pub_methods_classgr__sync__decimator"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__decimator.html#a23c657d3c3f0482369648e1916751f6f">fixed_rate_ninput_to_noutput</a> (int ninput)</td></tr>
<tr class="memdesc:a23c657d3c3f0482369648e1916751f6f inherit pub_methods_classgr__sync__decimator"><td class="mdescLeft"> </td><td class="mdescRight">Given ninput samples, return number of output samples that will be produced. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. <a href="#a23c657d3c3f0482369648e1916751f6f"></a><br/></td></tr>
<tr class="separator:a23c657d3c3f0482369648e1916751f6f inherit pub_methods_classgr__sync__decimator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a90041d67e72c64cb4d0f9a29bfbbd776 inherit pub_methods_classgr__sync__decimator"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__decimator.html#a90041d67e72c64cb4d0f9a29bfbbd776">fixed_rate_noutput_to_ninput</a> (int noutput)</td></tr>
<tr class="memdesc:a90041d67e72c64cb4d0f9a29bfbbd776 inherit pub_methods_classgr__sync__decimator"><td class="mdescLeft"> </td><td class="mdescRight">Given noutput samples, return number of input samples required to produce noutput. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. <a href="#a90041d67e72c64cb4d0f9a29bfbbd776"></a><br/></td></tr>
<tr class="separator:a90041d67e72c64cb4d0f9a29bfbbd776 inherit pub_methods_classgr__sync__decimator"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a75a949fcb7db89d914badc618b282615"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__pn__correlator__cc.html#a75a949fcb7db89d914badc618b282615">gr_pn_correlator_cc</a> (int degree, int mask, int seed)</td></tr>
<tr class="separator:a75a949fcb7db89d914badc618b282615"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_classgr__sync__decimator"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classgr__sync__decimator')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classgr__sync__decimator.html">gr_sync_decimator</a></td></tr>
<tr class="memitem:a63d1f4367c00048136d0ed383a96975c inherit pro_methods_classgr__sync__decimator"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__decimator.html#a63d1f4367c00048136d0ed383a96975c">gr_sync_decimator</a> (<a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a>)</td></tr>
<tr class="separator:a63d1f4367c00048136d0ed383a96975c inherit pro_methods_classgr__sync__decimator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad3871148480f33b75202744974d9241c inherit pro_methods_classgr__sync__decimator"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__decimator.html#ad3871148480f33b75202744974d9241c">gr_sync_decimator</a> (const std::string &<a class="el" href="classgr__basic__block.html#aa12a20d8b8eab341da935530d29299d2">name</a>, <a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> <a class="el" href="classgr__basic__block.html#a58f6d05e85931200f3771d3e50741281">input_signature</a>, <a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> <a class="el" href="classgr__basic__block.html#add68b96f012dfe352700b4fd1c3a184a">output_signature</a>, unsigned <a class="el" href="classgr__sync__decimator.html#a285a3292be71f47df2e8f10a779eb752">decimation</a>)</td></tr>
<tr class="separator:ad3871148480f33b75202744974d9241c inherit pro_methods_classgr__sync__decimator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_classgr__sync__block"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classgr__sync__block')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classgr__sync__block.html">gr_sync_block</a></td></tr>
<tr class="memitem:a8e8100cc8cafbc89a0cd64fbc2fc4153 inherit pro_methods_classgr__sync__block"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__block.html#a8e8100cc8cafbc89a0cd64fbc2fc4153">gr_sync_block</a> (<a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a>)</td></tr>
<tr class="separator:a8e8100cc8cafbc89a0cd64fbc2fc4153 inherit pro_methods_classgr__sync__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a832d8dad2dbd38e8e9cfa0b954d37c87 inherit pro_methods_classgr__sync__block"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__sync__block.html#a832d8dad2dbd38e8e9cfa0b954d37c87">gr_sync_block</a> (const std::string &<a class="el" href="classgr__basic__block.html#aa12a20d8b8eab341da935530d29299d2">name</a>, <a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> <a class="el" href="classgr__basic__block.html#a58f6d05e85931200f3771d3e50741281">input_signature</a>, <a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> <a class="el" href="classgr__basic__block.html#add68b96f012dfe352700b4fd1c3a184a">output_signature</a>)</td></tr>
<tr class="separator:a832d8dad2dbd38e8e9cfa0b954d37c87 inherit pro_methods_classgr__sync__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_classgr__block"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classgr__block')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classgr__block.html">gr_block</a></td></tr>
<tr class="memitem:ac94442f2da43c516ce4b8d3eb15fc316 inherit pro_methods_classgr__block"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#ac94442f2da43c516ce4b8d3eb15fc316">gr_block</a> (<a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a>)</td></tr>
<tr class="separator:ac94442f2da43c516ce4b8d3eb15fc316 inherit pro_methods_classgr__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a268510acce1f94c0a60c5273f4948641 inherit pro_methods_classgr__block"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a268510acce1f94c0a60c5273f4948641">gr_block</a> (const std::string &<a class="el" href="classgr__basic__block.html#aa12a20d8b8eab341da935530d29299d2">name</a>, <a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> <a class="el" href="classgr__basic__block.html#a58f6d05e85931200f3771d3e50741281">input_signature</a>, <a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> <a class="el" href="classgr__basic__block.html#add68b96f012dfe352700b4fd1c3a184a">output_signature</a>)</td></tr>
<tr class="separator:a268510acce1f94c0a60c5273f4948641 inherit pro_methods_classgr__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a176a95343488a9a760c8edf8bb08db20 inherit pro_methods_classgr__block"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a176a95343488a9a760c8edf8bb08db20">set_fixed_rate</a> (bool <a class="el" href="classgr__block.html#ab4eeb29440f674815ab3b44b4fb0c34d">fixed_rate</a>)</td></tr>
<tr class="separator:a176a95343488a9a760c8edf8bb08db20 inherit pro_methods_classgr__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7578dece9d597abe61db91aae8a0df83 inherit pro_methods_classgr__block"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a7578dece9d597abe61db91aae8a0df83">add_item_tag</a> (unsigned int which_output, <a class="el" href="stdint_8h.html#aec6fcb673ff035718c238c8c9d544c47">uint64_t</a> abs_offset, const <a class="el" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa">pmt::pmt_t</a> &key, const <a class="el" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa">pmt::pmt_t</a> &value, const <a class="el" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa">pmt::pmt_t</a> &srcid=<a class="el" href="namespacepmt.html#a92bfd358b0758d5edf5a0fac84ab806f">pmt::PMT_F</a>)</td></tr>
<tr class="memdesc:a7578dece9d597abe61db91aae8a0df83 inherit pro_methods_classgr__block"><td class="mdescLeft"> </td><td class="mdescRight">Adds a new tag onto the given output buffer. <a href="#a7578dece9d597abe61db91aae8a0df83"></a><br/></td></tr>
<tr class="separator:a7578dece9d597abe61db91aae8a0df83 inherit pro_methods_classgr__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8ef6a9b0086e00d80f10ccc8a7df321 inherit pro_methods_classgr__block"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#ac8ef6a9b0086e00d80f10ccc8a7df321">add_item_tag</a> (unsigned int which_output, const <a class="el" href="structgr__tag__t.html">gr_tag_t</a> &tag)</td></tr>
<tr class="memdesc:ac8ef6a9b0086e00d80f10ccc8a7df321 inherit pro_methods_classgr__block"><td class="mdescLeft"> </td><td class="mdescRight">Adds a new tag onto the given output buffer. <a href="#ac8ef6a9b0086e00d80f10ccc8a7df321"></a><br/></td></tr>
<tr class="separator:ac8ef6a9b0086e00d80f10ccc8a7df321 inherit pro_methods_classgr__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a44cd23e643d17717a0e872dc3a5e3c51 inherit pro_methods_classgr__block"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a44cd23e643d17717a0e872dc3a5e3c51">remove_item_tag</a> (unsigned int which_input, <a class="el" href="stdint_8h.html#aec6fcb673ff035718c238c8c9d544c47">uint64_t</a> abs_offset, const <a class="el" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa">pmt::pmt_t</a> &key, const <a class="el" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa">pmt::pmt_t</a> &value, const <a class="el" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa">pmt::pmt_t</a> &srcid=<a class="el" href="namespacepmt.html#a92bfd358b0758d5edf5a0fac84ab806f">pmt::PMT_F</a>)</td></tr>
<tr class="memdesc:a44cd23e643d17717a0e872dc3a5e3c51 inherit pro_methods_classgr__block"><td class="mdescLeft"> </td><td class="mdescRight">Removes a tag from the given input buffer. <a href="#a44cd23e643d17717a0e872dc3a5e3c51"></a><br/></td></tr>
<tr class="separator:a44cd23e643d17717a0e872dc3a5e3c51 inherit pro_methods_classgr__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a682b23dd7099d808343010ea3c76350e inherit pro_methods_classgr__block"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a682b23dd7099d808343010ea3c76350e">remove_item_tag</a> (unsigned int which_input, const <a class="el" href="structgr__tag__t.html">gr_tag_t</a> &tag)</td></tr>
<tr class="memdesc:a682b23dd7099d808343010ea3c76350e inherit pro_methods_classgr__block"><td class="mdescLeft"> </td><td class="mdescRight">Removes a tag from the given input buffer. <a href="#a682b23dd7099d808343010ea3c76350e"></a><br/></td></tr>
<tr class="separator:a682b23dd7099d808343010ea3c76350e inherit pro_methods_classgr__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54f69c4cd5ef5b05ac58d0128256def1 inherit pro_methods_classgr__block"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a54f69c4cd5ef5b05ac58d0128256def1">get_tags_in_range</a> (std::vector< <a class="el" href="structgr__tag__t.html">gr_tag_t</a> > &v, unsigned int which_input, <a class="el" href="stdint_8h.html#aec6fcb673ff035718c238c8c9d544c47">uint64_t</a> abs_start, <a class="el" href="stdint_8h.html#aec6fcb673ff035718c238c8c9d544c47">uint64_t</a> abs_end)</td></tr>
<tr class="memdesc:a54f69c4cd5ef5b05ac58d0128256def1 inherit pro_methods_classgr__block"><td class="mdescLeft"> </td><td class="mdescRight">Given a [start,end), returns a vector of all tags in the range. <a href="#a54f69c4cd5ef5b05ac58d0128256def1"></a><br/></td></tr>
<tr class="separator:a54f69c4cd5ef5b05ac58d0128256def1 inherit pro_methods_classgr__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab2650baa0c05713fc04664e69dde565d inherit pro_methods_classgr__block"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#ab2650baa0c05713fc04664e69dde565d">get_tags_in_range</a> (std::vector< <a class="el" href="structgr__tag__t.html">gr_tag_t</a> > &v, unsigned int which_input, <a class="el" href="stdint_8h.html#aec6fcb673ff035718c238c8c9d544c47">uint64_t</a> abs_start, <a class="el" href="stdint_8h.html#aec6fcb673ff035718c238c8c9d544c47">uint64_t</a> abs_end, const <a class="el" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa">pmt::pmt_t</a> &key)</td></tr>
<tr class="memdesc:ab2650baa0c05713fc04664e69dde565d inherit pro_methods_classgr__block"><td class="mdescLeft"> </td><td class="mdescRight">Given a [start,end), returns a vector of all tags in the range with a given key. <a href="#ab2650baa0c05713fc04664e69dde565d"></a><br/></td></tr>
<tr class="separator:ab2650baa0c05713fc04664e69dde565d inherit pro_methods_classgr__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_classgr__basic__block"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classgr__basic__block')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classgr__basic__block.html">gr_basic_block</a></td></tr>
<tr class="memitem:a84d1e93b57e52efb18a5aa90a3eaf2db inherit pro_methods_classgr__basic__block"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__basic__block.html#a84d1e93b57e52efb18a5aa90a3eaf2db">gr_basic_block</a> (<a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a>)</td></tr>
<tr class="separator:a84d1e93b57e52efb18a5aa90a3eaf2db inherit pro_methods_classgr__basic__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1183eee484f58953a2fed4c792e46245 inherit pro_methods_classgr__basic__block"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__basic__block.html#a1183eee484f58953a2fed4c792e46245">gr_basic_block</a> (const std::string &<a class="el" href="classgr__basic__block.html#aa12a20d8b8eab341da935530d29299d2">name</a>, <a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> <a class="el" href="classgr__basic__block.html#a58f6d05e85931200f3771d3e50741281">input_signature</a>, <a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> <a class="el" href="classgr__basic__block.html#add68b96f012dfe352700b4fd1c3a184a">output_signature</a>)</td></tr>
<tr class="memdesc:a1183eee484f58953a2fed4c792e46245 inherit pro_methods_classgr__basic__block"><td class="mdescLeft"> </td><td class="mdescRight">Protected constructor prevents instantiation by non-derived classes. <a href="#a1183eee484f58953a2fed4c792e46245"></a><br/></td></tr>
<tr class="separator:a1183eee484f58953a2fed4c792e46245 inherit pro_methods_classgr__basic__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a419d0fbba0ca02d822cbc299b979de54 inherit pro_methods_classgr__basic__block"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__basic__block.html#a419d0fbba0ca02d822cbc299b979de54">set_input_signature</a> (<a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> iosig)</td></tr>
<tr class="memdesc:a419d0fbba0ca02d822cbc299b979de54 inherit pro_methods_classgr__basic__block"><td class="mdescLeft"> </td><td class="mdescRight">may only be called during constructor <a href="#a419d0fbba0ca02d822cbc299b979de54"></a><br/></td></tr>
<tr class="separator:a419d0fbba0ca02d822cbc299b979de54 inherit pro_methods_classgr__basic__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a949b6ad69ebfdf423835265db99cf63d inherit pro_methods_classgr__basic__block"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__basic__block.html#a949b6ad69ebfdf423835265db99cf63d">set_output_signature</a> (<a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> iosig)</td></tr>
<tr class="memdesc:a949b6ad69ebfdf423835265db99cf63d inherit pro_methods_classgr__basic__block"><td class="mdescLeft"> </td><td class="mdescRight">may only be called during constructor <a href="#a949b6ad69ebfdf423835265db99cf63d"></a><br/></td></tr>
<tr class="separator:a949b6ad69ebfdf423835265db99cf63d inherit pro_methods_classgr__basic__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0821ef947158670d53bf0739f3c8877b inherit pro_methods_classgr__basic__block"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__basic__block.html#a0821ef947158670d53bf0739f3c8877b">set_color</a> (<a class="el" href="classgr__basic__block.html#a5c90b7c003ddd61f8df6bef2aceeab3d">vcolor</a> <a class="el" href="classgr__basic__block.html#a1cedb1704b6c00977c681b378ede384c">color</a>)</td></tr>
<tr class="memdesc:a0821ef947158670d53bf0739f3c8877b inherit pro_methods_classgr__basic__block"><td class="mdescLeft"> </td><td class="mdescRight">Allow the flowgraph to set for sorting and partitioning. <a href="#a0821ef947158670d53bf0739f3c8877b"></a><br/></td></tr>
<tr class="separator:a0821ef947158670d53bf0739f3c8877b inherit pro_methods_classgr__basic__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1cedb1704b6c00977c681b378ede384c inherit pro_methods_classgr__basic__block"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgr__basic__block.html#a5c90b7c003ddd61f8df6bef2aceeab3d">vcolor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__basic__block.html#a1cedb1704b6c00977c681b378ede384c">color</a> () const </td></tr>
<tr class="separator:a1cedb1704b6c00977c681b378ede384c inherit pro_methods_classgr__basic__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a6acf1d0309a0dadf9f234548272c0b inherit pro_methods_classgr__basic__block"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__basic__block.html#a0a6acf1d0309a0dadf9f234548272c0b">has_msg_handler</a> (<a class="el" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa">pmt::pmt_t</a> which_port)</td></tr>
<tr class="memdesc:a0a6acf1d0309a0dadf9f234548272c0b inherit pro_methods_classgr__basic__block"><td class="mdescLeft"> </td><td class="mdescRight">Tests if there is a handler attached to port <code>which_port</code>. <a href="#a0a6acf1d0309a0dadf9f234548272c0b"></a><br/></td></tr>
<tr class="separator:a0a6acf1d0309a0dadf9f234548272c0b inherit pro_methods_classgr__basic__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6076946479217a4d22cccfe415dcf172 inherit pro_methods_classgr__basic__block"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__basic__block.html#a6076946479217a4d22cccfe415dcf172">dispatch_msg</a> (<a class="el" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa">pmt::pmt_t</a> which_port, <a class="el" href="namespacepmt.html#ab4b70d9293452eb74dd07c670e6811fa">pmt::pmt_t</a> msg)</td></tr>
<tr class="separator:a6076946479217a4d22cccfe415dcf172 inherit pro_methods_classgr__basic__block"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a4625765597f95b0a8205995dcdad6d40"><td class="memItemLeft" align="right" valign="top"><a class="el" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <br class="typebreak"/>
<a class="el" href="classboost_1_1shared__ptr.html">gr_pn_correlator_cc_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__pn__correlator__cc.html#a4625765597f95b0a8205995dcdad6d40">gr_make_pn_correlator_cc</a> (int degree, int mask, int seed)</td></tr>
<tr class="separator:a4625765597f95b0a8205995dcdad6d40"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classgr__block"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classgr__block')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classgr__block.html">gr_block</a></td></tr>
<tr class="memitem:af026aa236701757fd5f71129daad883c inherit pub_types_classgr__block"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <a class="el" href="classgr__block.html#af026aa236701757fd5f71129daad883ca248a1e0554813ce26007ff5ec1530392">WORK_CALLED_PRODUCE</a> = -2,
<a class="el" href="classgr__block.html#af026aa236701757fd5f71129daad883ca221c2211857dcee81fb2bbb97fe6b223">WORK_DONE</a> = -1
}</td></tr>
<tr class="memdesc:af026aa236701757fd5f71129daad883c"><td class="mdescLeft"> </td><td class="mdescRight">Magic return values from general_work. <a href="classgr__block.html#af026aa236701757fd5f71129daad883c">More...</a><br/></td></tr>
<tr class="separator:af026aa236701757fd5f71129daad883c inherit pub_types_classgr__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a32561c88f124ea07881879fe79840f61 inherit pub_types_classgr__block"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a32561c88f124ea07881879fe79840f61">tag_propagation_policy_t</a> { <a class="el" href="classgr__block.html#a32561c88f124ea07881879fe79840f61ad472255a4873399940aec9d614d82287">TPP_DONT</a> = 0,
<a class="el" href="classgr__block.html#a32561c88f124ea07881879fe79840f61ac59dabb0af9fac19958d18378f3cfbfb">TPP_ALL_TO_ALL</a> = 1,
<a class="el" href="classgr__block.html#a32561c88f124ea07881879fe79840f61a98228946b0f3b3887230269c9ba5a60f">TPP_ONE_TO_ONE</a> = 2
}</td></tr>
<tr class="separator:a32561c88f124ea07881879fe79840f61 inherit pub_types_classgr__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_types_classgr__basic__block"><td colspan="2" onclick="javascript:toggleInherit('pro_types_classgr__basic__block')"><img src="closed.png" alt="-"/> Protected Types inherited from <a class="el" href="classgr__basic__block.html">gr_basic_block</a></td></tr>
<tr class="memitem:a5c90b7c003ddd61f8df6bef2aceeab3d inherit pro_types_classgr__basic__block"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__basic__block.html#a5c90b7c003ddd61f8df6bef2aceeab3d">vcolor</a> { <a class="el" href="classgr__basic__block.html#a5c90b7c003ddd61f8df6bef2aceeab3da476d594a077e729bad0f2cfa2008c899">WHITE</a>,
<a class="el" href="classgr__basic__block.html#a5c90b7c003ddd61f8df6bef2aceeab3daa6cce7ec34a3f9cf917e545a743dc89f">GREY</a>,
<a class="el" href="classgr__basic__block.html#a5c90b7c003ddd61f8df6bef2aceeab3da0abd1c82699481ffa502e5bb8d7bdaec">BLACK</a>
}</td></tr>
<tr class="separator:a5c90b7c003ddd61f8df6bef2aceeab3d inherit pro_types_classgr__basic__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_attribs_classgr__block"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classgr__block')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classgr__block.html">gr_block</a></td></tr>
<tr class="memitem:ab467fa14adf6b63148588ffbbe266d82 inherit pro_attribs_classgr__block"><td class="memItemLeft" align="right" valign="top">std::vector< long > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#ab467fa14adf6b63148588ffbbe266d82">d_max_output_buffer</a></td></tr>
<tr class="separator:ab467fa14adf6b63148588ffbbe266d82 inherit pro_attribs_classgr__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c331f7d38508c9955ef01f483c573d6 inherit pro_attribs_classgr__block"><td class="memItemLeft" align="right" valign="top">std::vector< long > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a9c331f7d38508c9955ef01f483c573d6">d_min_output_buffer</a></td></tr>
<tr class="separator:a9c331f7d38508c9955ef01f483c573d6 inherit pro_attribs_classgr__block"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace960ec997da0fff8fc44168983b1a55 inherit pro_attribs_classgr__block"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegruel.html#a16a913898c1d7f7a8ee459eb7ace413d">gruel::mutex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#ace960ec997da0fff8fc44168983b1a55">d_setlock</a></td></tr>
<tr class="separator:ace960ec997da0fff8fc44168983b1a55 inherit pro_attribs_classgr__block"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>PN code sequential search correlator. </p>
<p>Receives complex baseband signal, outputs complex correlation against reference PN code, one sample per PN code period </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a75a949fcb7db89d914badc618b282615"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gr_pn_correlator_cc::gr_pn_correlator_cc </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>degree</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>mask</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>seed</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a2c7e3f34bc9e5895220c4ea874950f96"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_pn_correlator_cc::~gr_pn_correlator_cc </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a27f4a2a6353c363482ae9dba1eac5cda"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int gr_pn_correlator_cc::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="gr__types_8h.html#a9852a3d906d823cb70eb9c29e7f2a43d">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="gr__types_8h.html#acd3f499576e769966ea44554b359d949">gr_vector_void_star</a> & </td>
<td class="paramname"><em>output_items</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>just like <a class="el" href="classgr__block.html#adf59080d10f322e3816b7ac8f7cb2a7c" 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>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="a4625765597f95b0a8205995dcdad6d40"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="el" href="classboost_1_1shared__ptr.html">gr_pn_correlator_cc_sptr</a> gr_make_pn_correlator_cc </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>degree</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>mask</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>seed</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </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__pn__correlator__cc_8h_source.html">gr_pn_correlator_cc.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classgr__pn__correlator__cc.html">gr_pn_correlator_cc</a></li>
<li class="footer">Generated on Fri Apr 19 2013 16:20:38 for GNU Radio 3.6.4.1 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
</ul>
</div>
</body>
</html>
