210 lines
10 KiB
HTML
210 lines
10 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||
<meta name="generator" content="Doxygen 1.9.8"/>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
<title>RadioLib: RadioLibBCH 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="navtreedata.js"></script>
|
||
<script type="text/javascript" src="navtree.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>
|
||
<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 id="projectrow">
|
||
<td id="projectalign">
|
||
<div id="projectname">RadioLib
|
||
</div>
|
||
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<!-- end header part -->
|
||
<!-- Generated by Doxygen 1.9.8 -->
|
||
<script type="text/javascript">
|
||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||
/* @license-end */
|
||
</script>
|
||
<script type="text/javascript" src="menudata.js"></script>
|
||
<script type="text/javascript" src="menu.js"></script>
|
||
<script type="text/javascript">
|
||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||
$(function() {
|
||
initMenu('',true,false,'search.php','Search');
|
||
$(document).ready(function() { init_search(); });
|
||
});
|
||
/* @license-end */
|
||
</script>
|
||
<div id="main-nav"></div>
|
||
</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">
|
||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||
$(document).ready(function(){initNavTree('class_radio_lib_b_c_h.html',''); initResizable(); });
|
||
/* @license-end */
|
||
</script>
|
||
<div id="doc-content">
|
||
<!-- 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">
|
||
<div id="MSearchResults">
|
||
<div class="SRPage">
|
||
<div id="SRIndex">
|
||
<div id="SRResults"></div>
|
||
<div class="SRStatus" id="Loading">Loading...</div>
|
||
<div class="SRStatus" id="Searching">Searching...</div>
|
||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="header">
|
||
<div class="summary">
|
||
<a href="#pub-methods">Public Member Functions</a> |
|
||
<a href="class_radio_lib_b_c_h-members.html">List of all members</a> </div>
|
||
<div class="headertitle"><div class="title">RadioLibBCH Class Reference</div></div>
|
||
</div><!--header-->
|
||
<div class="contents">
|
||
|
||
<p>Class to calculate Bose–Chaudhuri–Hocquenghem (BCH) class of forward error correction codes. In theory, this should be able to calculate an arbitrary BCH(N, K) code, but so far it was only tested for BCH(31, 21).
|
||
<a href="class_radio_lib_b_c_h.html#details">More...</a></p>
|
||
|
||
<p><code>#include <<a class="el" href="_f_e_c_8h_source.html">FEC.h</a>></code></p>
|
||
<table class="memberdecls">
|
||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
||
Public Member Functions</h2></td></tr>
|
||
<tr class="memitem:a39d55c0292e4c9337ee0672cd5241118" id="r_a39d55c0292e4c9337ee0672cd5241118"><td class="memItemLeft" align="right" valign="top"><a id="a39d55c0292e4c9337ee0672cd5241118" name="a39d55c0292e4c9337ee0672cd5241118"></a>
|
||
 </td><td class="memItemRight" valign="bottom"><b>RadioLibBCH</b> ()</td></tr>
|
||
<tr class="memdesc:a39d55c0292e4c9337ee0672cd5241118"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
||
<tr class="separator:a39d55c0292e4c9337ee0672cd5241118"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:ac4ceca6f132ff2047e2ca13d8d00a9e5" id="r_ac4ceca6f132ff2047e2ca13d8d00a9e5"><td class="memItemLeft" align="right" valign="top"><a id="ac4ceca6f132ff2047e2ca13d8d00a9e5" name="ac4ceca6f132ff2047e2ca13d8d00a9e5"></a>
|
||
 </td><td class="memItemRight" valign="bottom"><b>~RadioLibBCH</b> ()</td></tr>
|
||
<tr class="memdesc:ac4ceca6f132ff2047e2ca13d8d00a9e5"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <br /></td></tr>
|
||
<tr class="separator:ac4ceca6f132ff2047e2ca13d8d00a9e5"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:aba6f10d4ac2d40eb2222d1081a34c88b" id="r_aba6f10d4ac2d40eb2222d1081a34c88b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_b_c_h.html#aba6f10d4ac2d40eb2222d1081a34c88b">begin</a> (uint8_t n, uint8_t k, uint32_t poly)</td></tr>
|
||
<tr class="memdesc:aba6f10d4ac2d40eb2222d1081a34c88b"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method. <br /></td></tr>
|
||
<tr class="separator:aba6f10d4ac2d40eb2222d1081a34c88b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
<tr class="memitem:afa0a2eb58245715536acb781cd351d8a" id="r_afa0a2eb58245715536acb781cd351d8a"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_b_c_h.html#afa0a2eb58245715536acb781cd351d8a">encode</a> (uint32_t dataword)</td></tr>
|
||
<tr class="memdesc:afa0a2eb58245715536acb781cd351d8a"><td class="mdescLeft"> </td><td class="mdescRight">Encoding method - encodes one data word (without check bits) into a code word (with check bits). <br /></td></tr>
|
||
<tr class="separator:afa0a2eb58245715536acb781cd351d8a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
</table>
|
||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
<div class="textblock"><p>Class to calculate Bose–Chaudhuri–Hocquenghem (BCH) class of forward error correction codes. In theory, this should be able to calculate an arbitrary BCH(N, K) code, but so far it was only tested for BCH(31, 21). </p>
|
||
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||
<a id="aba6f10d4ac2d40eb2222d1081a34c88b" name="aba6f10d4ac2d40eb2222d1081a34c88b"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#aba6f10d4ac2d40eb2222d1081a34c88b">◆ </a></span>begin()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">void RadioLibBCH::begin </td>
|
||
<td>(</td>
|
||
<td class="paramtype">uint8_t </td>
|
||
<td class="paramname"><em>n</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">uint8_t </td>
|
||
<td class="paramname"><em>k</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="paramkey"></td>
|
||
<td></td>
|
||
<td class="paramtype">uint32_t </td>
|
||
<td class="paramname"><em>poly</em> </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td>)</td>
|
||
<td></td><td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Initialization method. </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">n</td><td>Code word length in bits, up to 32. </td></tr>
|
||
<tr><td class="paramname">k</td><td>Data portion length in bits, up to "n". </td></tr>
|
||
<tr><td class="paramname">poly</td><td>Powers of the irreducible polynomial. </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
|
||
</div>
|
||
</div>
|
||
<a id="afa0a2eb58245715536acb781cd351d8a" name="afa0a2eb58245715536acb781cd351d8a"></a>
|
||
<h2 class="memtitle"><span class="permalink"><a href="#afa0a2eb58245715536acb781cd351d8a">◆ </a></span>encode()</h2>
|
||
|
||
<div class="memitem">
|
||
<div class="memproto">
|
||
<table class="memname">
|
||
<tr>
|
||
<td class="memname">uint32_t RadioLibBCH::encode </td>
|
||
<td>(</td>
|
||
<td class="paramtype">uint32_t </td>
|
||
<td class="paramname"><em>dataword</em></td><td>)</td>
|
||
<td></td>
|
||
</tr>
|
||
</table>
|
||
</div><div class="memdoc">
|
||
|
||
<p>Encoding method - encodes one data word (without check bits) into a code word (with check bits). </p>
|
||
<dl class="params"><dt>Parameters</dt><dd>
|
||
<table class="params">
|
||
<tr><td class="paramname">dataword</td><td>Data word without check bits. The caller is responsible to make sure the data is on the correct bit positions! </td></tr>
|
||
</table>
|
||
</dd>
|
||
</dl>
|
||
<dl class="section return"><dt>Returns</dt><dd>Code word with error check bits. </dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<hr/>The documentation for this class was generated from the following files:<ul>
|
||
<li>src/utils/<a class="el" href="_f_e_c_8h_source.html">FEC.h</a></li>
|
||
<li>src/utils/<b>FEC.cpp</b></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="class_radio_lib_b_c_h.html">RadioLibBCH</a></li>
|
||
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
|
||
</ul>
|
||
</div>
|
||
</body>
|
||
</html>
|