You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
libsdr/classsdr_1_1_p_o_c_s_a_g.html

541 lines
30 KiB
HTML

<!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.9.1"/>
<title>libsdr: sdr::POCSAG 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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">libsdr
&#160;<span id="projectnumber">0.1.0</span>
</div>
<div id="projectbrief">A simple SDR library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>sdr</b></li><li class="navelem"><a class="el" href="classsdr_1_1_p_o_c_s_a_g.html">POCSAG</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-types">Protected Types</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classsdr_1_1_p_o_c_s_a_g-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">sdr::POCSAG Class Reference<div class="ingroups"><a class="el" href="group__datanodes.html">Data handling nodes.</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Implements a <a class="el" href="classsdr_1_1_p_o_c_s_a_g.html" title="Implements a POCSAG decoder. ">POCSAG</a> decoder.
<a href="classsdr_1_1_p_o_c_s_a_g.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="pocsag_8hh_source.html">pocsag.hh</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for sdr::POCSAG:</div>
<div class="dyncontent">
<div class="center">
<img src="classsdr_1_1_p_o_c_s_a_g.png" usemap="#sdr::POCSAG_map" alt=""/>
<map id="sdr::POCSAG_map" name="sdr::POCSAG_map">
<area href="classsdr_1_1_sink.html" alt="sdr::Sink&lt; uint8_t &gt;" shape="rect" coords="0,56,121,80"/>
<area href="classsdr_1_1_sink_base.html" title="Basic interface of all Sinks. " alt="sdr::SinkBase" shape="rect" coords="0,0,121,24"/>
<area href="classsdr_1_1_p_o_c_s_a_g_dump.html" title="A simple extention of the POCSAG node that prints the received messages to a std::ostream. " alt="sdr::POCSAGDump" shape="rect" coords="0,168,121,192"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_p_o_c_s_a_g_1_1_message.html">Message</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A pocsag message. <a href="classsdr_1_1_p_o_c_s_a_g_1_1_message.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a638518f0152c9dd0b39f97681a3b4253"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_p_o_c_s_a_g.html#a638518f0152c9dd0b39f97681a3b4253">POCSAG</a> ()</td></tr>
<tr class="memdesc:a638518f0152c9dd0b39f97681a3b4253"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a638518f0152c9dd0b39f97681a3b4253">More...</a><br /></td></tr>
<tr class="separator:a638518f0152c9dd0b39f97681a3b4253"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e6fcb4a9cb1aeb98918a60d57b33a93"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_p_o_c_s_a_g.html#a1e6fcb4a9cb1aeb98918a60d57b33a93">config</a> (const <a class="el" href="classsdr_1_1_config.html">Config</a> &amp;src_cfg)</td></tr>
<tr class="memdesc:a1e6fcb4a9cb1aeb98918a60d57b33a93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Needs to be implemented by any sub-type to check and perform the configuration of the node. <a href="#a1e6fcb4a9cb1aeb98918a60d57b33a93">More...</a><br /></td></tr>
<tr class="separator:a1e6fcb4a9cb1aeb98918a60d57b33a93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea8cef2e210e20d2a7e85e3d5f86922e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_p_o_c_s_a_g.html#aea8cef2e210e20d2a7e85e3d5f86922e">process</a> (const <a class="el" href="classsdr_1_1_buffer.html">Buffer</a>&lt; uint8_t &gt; &amp;buffer, bool allow_overwrite)</td></tr>
<tr class="memdesc:aea8cef2e210e20d2a7e85e3d5f86922e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Needs to be implemented by any sub-type to process the received data. <a href="#aea8cef2e210e20d2a7e85e3d5f86922e">More...</a><br /></td></tr>
<tr class="separator:aea8cef2e210e20d2a7e85e3d5f86922e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f0eacaffea8101ad5b93a723818f323"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_p_o_c_s_a_g.html#a0f0eacaffea8101ad5b93a723818f323">handleMessages</a> ()</td></tr>
<tr class="memdesc:a0f0eacaffea8101ad5b93a723818f323"><td class="mdescLeft">&#160;</td><td class="mdescRight">Can be overwritten by any other implementation to process the received messages stored in <code>_queue</code>. <a href="#a0f0eacaffea8101ad5b93a723818f323">More...</a><br /></td></tr>
<tr class="separator:a0f0eacaffea8101ad5b93a723818f323"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classsdr_1_1_sink"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classsdr_1_1_sink')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classsdr_1_1_sink.html">sdr::Sink&lt; uint8_t &gt;</a></td></tr>
<tr class="memitem:a1a5279c1507276612797734eed890ecb inherit pub_methods_classsdr_1_1_sink"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_sink.html#a1a5279c1507276612797734eed890ecb">Sink</a> ()</td></tr>
<tr class="memdesc:a1a5279c1507276612797734eed890ecb inherit pub_methods_classsdr_1_1_sink"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a1a5279c1507276612797734eed890ecb">More...</a><br /></td></tr>
<tr class="separator:a1a5279c1507276612797734eed890ecb inherit pub_methods_classsdr_1_1_sink"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad17413f3a75305f326b7c3885be9279a inherit pub_methods_classsdr_1_1_sink"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_sink.html#ad17413f3a75305f326b7c3885be9279a">~Sink</a> ()</td></tr>
<tr class="memdesc:ad17413f3a75305f326b7c3885be9279a inherit pub_methods_classsdr_1_1_sink"><td class="mdescLeft">&#160;</td><td class="mdescRight">Drestructor. <a href="#ad17413f3a75305f326b7c3885be9279a">More...</a><br /></td></tr>
<tr class="separator:ad17413f3a75305f326b7c3885be9279a inherit pub_methods_classsdr_1_1_sink"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25b0849e40053f87496ca72f8b8cd9e2 inherit pub_methods_classsdr_1_1_sink"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_sink.html#a25b0849e40053f87496ca72f8b8cd9e2">handleBuffer</a> (const <a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> &amp;buffer, bool allow_overwrite)</td></tr>
<tr class="memdesc:a25b0849e40053f87496ca72f8b8cd9e2 inherit pub_methods_classsdr_1_1_sink"><td class="mdescLeft">&#160;</td><td class="mdescRight">Re-implemented from <code>SinkBase</code>. <a href="#a25b0849e40053f87496ca72f8b8cd9e2">More...</a><br /></td></tr>
<tr class="separator:a25b0849e40053f87496ca72f8b8cd9e2 inherit pub_methods_classsdr_1_1_sink"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classsdr_1_1_sink_base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classsdr_1_1_sink_base')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classsdr_1_1_sink_base.html">sdr::SinkBase</a></td></tr>
<tr class="memitem:aaa9fb7219aa47e809ff1d62a819a2d57 inherit pub_methods_classsdr_1_1_sink_base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_sink_base.html#aaa9fb7219aa47e809ff1d62a819a2d57">SinkBase</a> ()</td></tr>
<tr class="memdesc:aaa9fb7219aa47e809ff1d62a819a2d57 inherit pub_methods_classsdr_1_1_sink_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#aaa9fb7219aa47e809ff1d62a819a2d57">More...</a><br /></td></tr>
<tr class="separator:aaa9fb7219aa47e809ff1d62a819a2d57 inherit pub_methods_classsdr_1_1_sink_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a522205396205d6d3601da6a65bdaf75a inherit pub_methods_classsdr_1_1_sink_base"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_sink_base.html#a522205396205d6d3601da6a65bdaf75a">~SinkBase</a> ()</td></tr>
<tr class="memdesc:a522205396205d6d3601da6a65bdaf75a inherit pub_methods_classsdr_1_1_sink_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#a522205396205d6d3601da6a65bdaf75a">More...</a><br /></td></tr>
<tr class="separator:a522205396205d6d3601da6a65bdaf75a inherit pub_methods_classsdr_1_1_sink_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-types"></a>
Protected Types</h2></td></tr>
<tr class="memitem:ga2b69aab0584a38f7cfb2d245b4099287"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__datanodes.html#ga2b69aab0584a38f7cfb2d245b4099287">State</a> { <a class="el" href="group__datanodes.html#gga2b69aab0584a38f7cfb2d245b4099287a388e63dbe8e604130bd7d260f3f95750">WAIT</a>,
<a class="el" href="group__datanodes.html#gga2b69aab0584a38f7cfb2d245b4099287aa20ab6517b16763e35493b66701e639f">RECEIVE</a>,
<a class="el" href="group__datanodes.html#gga2b69aab0584a38f7cfb2d245b4099287ad7b38a50e2d7d2fdfd13448a7f5ea8d2">CHECK_CONTINUE</a>
}</td></tr>
<tr class="memdesc:ga2b69aab0584a38f7cfb2d245b4099287"><td class="mdescLeft">&#160;</td><td class="mdescRight">The possible states of the POGSAC receiver. <a href="group__datanodes.html#ga2b69aab0584a38f7cfb2d245b4099287">More...</a><br /></td></tr>
<tr class="separator:ga2b69aab0584a38f7cfb2d245b4099287"><td class="memSeparator" colspan="2">&#160;</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:aeb5e4b0a6ba63cd32c7ed2b3f92b4cd6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_p_o_c_s_a_g.html#aeb5e4b0a6ba63cd32c7ed2b3f92b4cd6">_process_word</a> (uint32_t word)</td></tr>
<tr class="memdesc:aeb5e4b0a6ba63cd32c7ed2b3f92b4cd6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process a POGSAC word. <a href="#aeb5e4b0a6ba63cd32c7ed2b3f92b4cd6">More...</a><br /></td></tr>
<tr class="separator:aeb5e4b0a6ba63cd32c7ed2b3f92b4cd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2702c7860abcb0444f3a7e0cbf8fc6d6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_p_o_c_s_a_g.html#a2702c7860abcb0444f3a7e0cbf8fc6d6">_reset_message</a> ()</td></tr>
<tr class="memdesc:a2702c7860abcb0444f3a7e0cbf8fc6d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the message. <a href="#a2702c7860abcb0444f3a7e0cbf8fc6d6">More...</a><br /></td></tr>
<tr class="separator:a2702c7860abcb0444f3a7e0cbf8fc6d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3301f898706ee6e654de09be053862e5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_p_o_c_s_a_g.html#a3301f898706ee6e654de09be053862e5">_finish_message</a> ()</td></tr>
<tr class="memdesc:a3301f898706ee6e654de09be053862e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the (non-empty) message to the queue. <a href="#a3301f898706ee6e654de09be053862e5">More...</a><br /></td></tr>
<tr class="separator:a3301f898706ee6e654de09be053862e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a42ccd24b9e2d295cff3c90167891f89b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__datanodes.html#ga2b69aab0584a38f7cfb2d245b4099287">State</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_p_o_c_s_a_g.html#a42ccd24b9e2d295cff3c90167891f89b">_state</a></td></tr>
<tr class="memdesc:a42ccd24b9e2d295cff3c90167891f89b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current state. <a href="#a42ccd24b9e2d295cff3c90167891f89b">More...</a><br /></td></tr>
<tr class="separator:a42ccd24b9e2d295cff3c90167891f89b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0b601f6e8721be1b0d8581a65c75cb0"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_p_o_c_s_a_g.html#ae0b601f6e8721be1b0d8581a65c75cb0">_bits</a></td></tr>
<tr class="memdesc:ae0b601f6e8721be1b0d8581a65c75cb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">The last received bits. <a href="#ae0b601f6e8721be1b0d8581a65c75cb0">More...</a><br /></td></tr>
<tr class="separator:ae0b601f6e8721be1b0d8581a65c75cb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1364abad88cecacde590ff638c876efc"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_p_o_c_s_a_g.html#a1364abad88cecacde590ff638c876efc">_bitcount</a></td></tr>
<tr class="memdesc:a1364abad88cecacde590ff638c876efc"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of received bits. <a href="#a1364abad88cecacde590ff638c876efc">More...</a><br /></td></tr>
<tr class="separator:a1364abad88cecacde590ff638c876efc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59ee26d6775bb623e3ab140b0152a014"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_p_o_c_s_a_g.html#a59ee26d6775bb623e3ab140b0152a014">_slot</a></td></tr>
<tr class="memdesc:a59ee26d6775bb623e3ab140b0152a014"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current slot. <a href="#a59ee26d6775bb623e3ab140b0152a014">More...</a><br /></td></tr>
<tr class="separator:a59ee26d6775bb623e3ab140b0152a014"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a625843082a3237b0603b744cdffe7c4e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsdr_1_1_p_o_c_s_a_g_1_1_message.html">Message</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_p_o_c_s_a_g.html#a625843082a3237b0603b744cdffe7c4e">_message</a></td></tr>
<tr class="memdesc:a625843082a3237b0603b744cdffe7c4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current message. <a href="#a625843082a3237b0603b744cdffe7c4e">More...</a><br /></td></tr>
<tr class="separator:a625843082a3237b0603b744cdffe7c4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd0ad902fb4f37a2179eaba7f103039f"><td class="memItemLeft" align="right" valign="top">std::list&lt; <a class="el" href="classsdr_1_1_p_o_c_s_a_g_1_1_message.html">Message</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_p_o_c_s_a_g.html#acd0ad902fb4f37a2179eaba7f103039f">_queue</a></td></tr>
<tr class="memdesc:acd0ad902fb4f37a2179eaba7f103039f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The completed messages. <a href="#acd0ad902fb4f37a2179eaba7f103039f">More...</a><br /></td></tr>
<tr class="separator:acd0ad902fb4f37a2179eaba7f103039f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implements a <a class="el" href="classsdr_1_1_p_o_c_s_a_g.html" title="Implements a POCSAG decoder. ">POCSAG</a> decoder. </p>
<p>In conjecture with the <code><a class="el" href="classsdr_1_1_f_s_k_detector.html" title="Implements the basic FSK/AFSK symbol detection. ">FSKDetector</a></code> or <code>AFSDetector</code> and the <code><a class="el" href="classsdr_1_1_bit_stream.html" title="Decodes a bitstream with the desired baud rate. ">BitStream</a></code> nodes, this node can be used to receive and process <a class="el" href="classsdr_1_1_p_o_c_s_a_g.html" title="Implements a POCSAG decoder. ">POCSAG</a> (pages) messages.</p>
<p>The <a class="el" href="classsdr_1_1_p_o_c_s_a_g.html" title="Implements a POCSAG decoder. ">POCSAG</a> protocol is defined as followig:</p>
<p>1) at least 576 bits of alternating value (1 0 1 0 ...) 2) a 32-bit sync word (0x7CD215D8) 3) 2x8 data words (each 32 bit) 4) If data left to send -&gt; continue with step 2</p>
<p>Unused data words are send as 0x7A89C197. Each dataword is either a address word (bit 31 = 0) or message word (bit 31 = 1). </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a638518f0152c9dd0b39f97681a3b4253"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">POCSAG::POCSAG </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a3301f898706ee6e654de09be053862e5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void POCSAG::_finish_message </td>
<td>(</td>
<td class="paramname"></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">
<p>Add the (non-empty) message to the queue. </p>
</div>
</div>
<a class="anchor" id="aeb5e4b0a6ba63cd32c7ed2b3f92b4cd6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void POCSAG::_process_word </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>word</em></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">
<p>Process a POGSAC word. </p>
</div>
</div>
<a class="anchor" id="a2702c7860abcb0444f3a7e0cbf8fc6d6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void POCSAG::_reset_message </td>
<td>(</td>
<td class="paramname"></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">
<p>Clear the message. </p>
</div>
</div>
<a class="anchor" id="a1e6fcb4a9cb1aeb98918a60d57b33a93"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void POCSAG::config </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsdr_1_1_config.html">Config</a> &amp;&#160;</td>
<td class="paramname"><em>src_cfg</em></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>Needs to be implemented by any sub-type to check and perform the configuration of the node. </p>
<p>Implements <a class="el" href="classsdr_1_1_sink_base.html#aacebf73840f06c82c438e352bf1eb75e">sdr::SinkBase</a>.</p>
</div>
</div>
<a class="anchor" id="a0f0eacaffea8101ad5b93a723818f323"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void POCSAG::handleMessages </td>
<td>(</td>
<td class="paramname"></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>Can be overwritten by any other implementation to process the received messages stored in <code>_queue</code>. </p>
<p>Reimplemented in <a class="el" href="classsdr_1_1_p_o_c_s_a_g_dump.html#a54de91cafeaf262ac32c8d3e55709508">sdr::POCSAGDump</a>.</p>
</div>
</div>
<a class="anchor" id="aea8cef2e210e20d2a7e85e3d5f86922e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void POCSAG::process </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsdr_1_1_buffer.html">Buffer</a>&lt; uint8_t &gt; &amp;&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>allow_overwrite</em>&#160;</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>Needs to be implemented by any sub-type to process the received data. </p>
<p>Implements <a class="el" href="classsdr_1_1_sink.html#aaa6fa5f784d5f328fc9c4e7b241a03e9">sdr::Sink&lt; uint8_t &gt;</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a1364abad88cecacde590ff638c876efc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t sdr::POCSAG::_bitcount</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of received bits. </p>
</div>
</div>
<a class="anchor" id="ae0b601f6e8721be1b0d8581a65c75cb0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint64_t sdr::POCSAG::_bits</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The last received bits. </p>
</div>
</div>
<a class="anchor" id="a625843082a3237b0603b744cdffe7c4e"></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="classsdr_1_1_p_o_c_s_a_g_1_1_message.html">Message</a> sdr::POCSAG::_message</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The current message. </p>
</div>
</div>
<a class="anchor" id="acd0ad902fb4f37a2179eaba7f103039f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::list&lt;<a class="el" href="classsdr_1_1_p_o_c_s_a_g_1_1_message.html">Message</a>&gt; sdr::POCSAG::_queue</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The completed messages. </p>
</div>
</div>
<a class="anchor" id="a59ee26d6775bb623e3ab140b0152a014"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t sdr::POCSAG::_slot</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The current slot. </p>
</div>
</div>
<a class="anchor" id="a42ccd24b9e2d295cff3c90167891f89b"></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="group__datanodes.html#ga2b69aab0584a38f7cfb2d245b4099287">State</a> sdr::POCSAG::_state</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The current state. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/Users/hannes/Uni/Elektronik/sdr/libsdr/src/<a class="el" href="pocsag_8hh_source.html">pocsag.hh</a></li>
<li>/Users/hannes/Uni/Elektronik/sdr/libsdr/src/pocsag.cc</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 2 2015 18:28:39 for libsdr by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>