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/group__datanodes.html

259 lines
19 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: Data handling nodes.</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><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><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">Data handling nodes.</div> </div>
</div><!--header-->
<div class="contents">
<p>This group collects all nodes related to data handling.
<a href="#details">More...</a></p>
<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_auto_cast.html">sdr::AutoCast&lt; Scalar &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This class performs some automatic casts to a certain buffer type (if possible) specified by the template argument. <a href="classsdr_1_1_auto_cast.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_a_x25.html">sdr::AX25</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decodes <a class="el" href="classsdr_1_1_a_x25.html" title="Decodes AX25 (PacketRadio) messages from a bit stream. ">AX25</a> (PacketRadio) messages from a bit stream. <a href="classsdr_1_1_a_x25.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_baudot.html">sdr::Baudot</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements a <a class="el" href="classsdr_1_1_baudot.html" title="Implements a Baudot decoder. ">Baudot</a> decoder. <a href="classsdr_1_1_baudot.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_buffer_node.html">sdr::BufferNode&lt; Scalar &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A simple buffering node, that ensures a fixed buffer size. <a href="classsdr_1_1_buffer_node.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_combine.html">sdr::Combine&lt; Scalar &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A combine node. <a href="classsdr_1_1_combine.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_interleave.html">sdr::Interleave&lt; Scalar &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interleaves several input streams. <a href="classsdr_1_1_interleave.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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">sdr::POCSAG::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>
<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.html">sdr::POCSAG</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">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><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_dump.html">sdr::POCSAGDump</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A simple extention of the <code><a class="el" href="classsdr_1_1_p_o_c_s_a_g.html" title="Implements a POCSAG decoder. ">POCSAG</a></code> node that prints the received messages to a <code>std::ostream</code>. <a href="classsdr_1_1_p_o_c_s_a_g_dump.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_varicode.html">sdr::Varicode</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simple varicode (Huffman code) decoder node. <a href="classsdr_1_1_varicode.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_real_imag_part.html">sdr::RealImagPart&lt; Scalar &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extracts the real or imaginary part of a complex valued data stream. <a href="classsdr_1_1_real_imag_part.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_real_part.html">sdr::RealPart&lt; Scalar &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Selects the real part of a complex signal. <a href="classsdr_1_1_real_part.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_imag_part.html">sdr::ImagPart&lt; Scalar &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Selects the imaginary part of a complex signal. <a href="classsdr_1_1_imag_part.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_to_complex.html">sdr::ToComplex&lt; iScalar, oScalar &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tiny helper node to transform a real part into a complex, including a possible type-cast. <a href="classsdr_1_1_to_complex.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_cast.html">sdr::Cast&lt; iScalar, oScalar &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Explicit type cast node. <a href="classsdr_1_1_cast.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_unsigned_to_signed.html">sdr::UnsignedToSigned</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs a reinterprete cast from an unsinged value to a singed one. <a href="classsdr_1_1_unsigned_to_signed.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_signed_to_unsigned.html">sdr::SignedToUnsigned</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs a reinterprete cast from an unsinged value to a singed one. <a href="classsdr_1_1_signed_to_unsigned.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="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga581aaffb59408dc43ed022365ca7cf9c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__datanodes.html#ga581aaffb59408dc43ed022365ca7cf9c">sdr::Baudot::Mode</a> { <a class="el" href="group__datanodes.html#gga581aaffb59408dc43ed022365ca7cf9ca5615602b4f97c915eaa9d0cbd9c31bc0">sdr::Baudot::LETTERS</a>,
<a class="el" href="group__datanodes.html#gga581aaffb59408dc43ed022365ca7cf9ca44d0f08e7c82b8eef81d27359b2f77be">sdr::Baudot::FIGURES</a>
}</td></tr>
<tr class="memdesc:ga581aaffb59408dc43ed022365ca7cf9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the current code-tables. <a href="group__datanodes.html#ga581aaffb59408dc43ed022365ca7cf9c">More...</a><br /></td></tr>
<tr class="separator:ga581aaffb59408dc43ed022365ca7cf9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadbb2fe468eeee0a50936513575d614f1"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__datanodes.html#gadbb2fe468eeee0a50936513575d614f1">sdr::Baudot::StopBits</a> { <a class="el" href="group__datanodes.html#ggadbb2fe468eeee0a50936513575d614f1aaf2382cb3b6e26632a185738cc5f2750">sdr::Baudot::STOP1</a>,
<a class="el" href="group__datanodes.html#ggadbb2fe468eeee0a50936513575d614f1a7d9962c0483f0858ccc73afabbd78e82">sdr::Baudot::STOP15</a>,
<a class="el" href="group__datanodes.html#ggadbb2fe468eeee0a50936513575d614f1aa953bb78837986b19b99f791db83f231">sdr::Baudot::STOP2</a>
}</td></tr>
<tr class="memdesc:gadbb2fe468eeee0a50936513575d614f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the number of stop bits. <a href="group__datanodes.html#gadbb2fe468eeee0a50936513575d614f1">More...</a><br /></td></tr>
<tr class="separator:gadbb2fe468eeee0a50936513575d614f1"><td class="memSeparator" colspan="2">&#160;</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">sdr::POCSAG::State</a> { <a class="el" href="group__datanodes.html#gga2b69aab0584a38f7cfb2d245b4099287a388e63dbe8e604130bd7d260f3f95750">sdr::POCSAG::WAIT</a>,
<a class="el" href="group__datanodes.html#gga2b69aab0584a38f7cfb2d245b4099287aa20ab6517b16763e35493b66701e639f">sdr::POCSAG::RECEIVE</a>,
<a class="el" href="group__datanodes.html#gga2b69aab0584a38f7cfb2d245b4099287ad7b38a50e2d7d2fdfd13448a7f5ea8d2">sdr::POCSAG::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>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>This group collects all nodes related to data handling. </p>
<p>I.e. type casts etc. </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga581aaffb59408dc43ed022365ca7cf9c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__datanodes.html#ga581aaffb59408dc43ed022365ca7cf9c">sdr::Baudot::Mode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies the current code-tables. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga581aaffb59408dc43ed022365ca7cf9ca5615602b4f97c915eaa9d0cbd9c31bc0"></a>LETTERS&#160;</td><td class="fielddoc">
<p>Letters. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga581aaffb59408dc43ed022365ca7cf9ca44d0f08e7c82b8eef81d27359b2f77be"></a>FIGURES&#160;</td><td class="fielddoc">
<p>Numbers, symbols etc. </p>
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="ga2b69aab0584a38f7cfb2d245b4099287"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__datanodes.html#ga2b69aab0584a38f7cfb2d245b4099287">sdr::POCSAG::State</a></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 possible states of the POGSAC receiver. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga2b69aab0584a38f7cfb2d245b4099287a388e63dbe8e604130bd7d260f3f95750"></a>WAIT&#160;</td><td class="fielddoc">
<p>Wait for a sync word. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga2b69aab0584a38f7cfb2d245b4099287aa20ab6517b16763e35493b66701e639f"></a>RECEIVE&#160;</td><td class="fielddoc">
<p>Receive data. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga2b69aab0584a38f7cfb2d245b4099287ad7b38a50e2d7d2fdfd13448a7f5ea8d2"></a>CHECK_CONTINUE&#160;</td><td class="fielddoc">
<p>Wait for the sync word for continuation. </p>
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="gadbb2fe468eeee0a50936513575d614f1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__datanodes.html#gadbb2fe468eeee0a50936513575d614f1">sdr::Baudot::StopBits</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies the number of stop bits. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggadbb2fe468eeee0a50936513575d614f1aaf2382cb3b6e26632a185738cc5f2750"></a>STOP1&#160;</td><td class="fielddoc">
<p>1 stop bit. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggadbb2fe468eeee0a50936513575d614f1a7d9962c0483f0858ccc73afabbd78e82"></a>STOP15&#160;</td><td class="fielddoc">
<p>1.5 stop bits. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggadbb2fe468eeee0a50936513575d614f1aa953bb78837986b19b99f791db83f231"></a>STOP2&#160;</td><td class="fielddoc">
<p>2 stop bits. </p>
</td></tr>
</table>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 2 2015 18:28:37 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>