RadioLibSmol/_i_t_a2_string_8h_source.html
2025-01-16 17:28:36 +00:00

168 lines
17 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: src/protocols/Print/ITA2String.h Source File</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&amp;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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
</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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('_i_t_a2_string_8h_source.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="headertitle"><div class="title">ITA2String.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#if !defined(_RADIOLIB_ITA2_STRING_H)</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define _RADIOLIB_ITA2_STRING_H</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &quot;../../TypeDef.h&quot;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#define RADIOLIB_ITA2_FIGS 0x1B</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#define RADIOLIB_ITA2_LTRS 0x1F</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#define RADIOLIB_ITA2_LENGTH 32</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">// ITA2 character table: - position in array corresponds to 5-bit ITA2 code</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// - characters to the left are in letters shift, characters to the right in figures shift</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">// - characters marked 0x7F do not have ASCII equivalent</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> ITA2Table[RADIOLIB_ITA2_LENGTH][2] RADIOLIB_NONVOLATILE = {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> {<span class="charliteral">&#39;\0&#39;</span>, <span class="charliteral">&#39;\0&#39;</span>}, {<span class="charliteral">&#39;E&#39;</span>, <span class="charliteral">&#39;3&#39;</span>}, {<span class="charliteral">&#39;\n&#39;</span>, <span class="charliteral">&#39;\n&#39;</span>}, {<span class="charliteral">&#39;A&#39;</span>, <span class="charliteral">&#39;-&#39;</span>}, {<span class="charliteral">&#39; &#39;</span>, <span class="charliteral">&#39; &#39;</span>}, {<span class="charliteral">&#39;S&#39;</span>, <span class="charliteral">&#39;\&#39;&#39;</span>}, {<span class="charliteral">&#39;I&#39;</span>, <span class="charliteral">&#39;8&#39;</span>}, {<span class="charliteral">&#39;U&#39;</span>, <span class="charliteral">&#39;7&#39;</span>},</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> {<span class="charliteral">&#39;\r&#39;</span>, <span class="charliteral">&#39;\r&#39;</span>}, {<span class="charliteral">&#39;D&#39;</span>, 0x05}, {<span class="charliteral">&#39;R&#39;</span>, <span class="charliteral">&#39;4&#39;</span>}, {<span class="charliteral">&#39;J&#39;</span>, <span class="charliteral">&#39;\a&#39;</span>}, {<span class="charliteral">&#39;N&#39;</span>, <span class="charliteral">&#39;,&#39;</span>}, {<span class="charliteral">&#39;F&#39;</span>, <span class="charliteral">&#39;!&#39;</span>}, {<span class="charliteral">&#39;C&#39;</span>, <span class="charliteral">&#39;:&#39;</span>}, {<span class="charliteral">&#39;K&#39;</span>, <span class="charliteral">&#39;(&#39;</span>},</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> {<span class="charliteral">&#39;T&#39;</span>, <span class="charliteral">&#39;5&#39;</span>}, {<span class="charliteral">&#39;Z&#39;</span>, <span class="charliteral">&#39;+&#39;</span>}, {<span class="charliteral">&#39;L&#39;</span>, <span class="charliteral">&#39;)&#39;</span>}, {<span class="charliteral">&#39;W&#39;</span>, <span class="charliteral">&#39;2&#39;</span>}, {<span class="charliteral">&#39;H&#39;</span>, 0x7F}, {<span class="charliteral">&#39;Y&#39;</span>, <span class="charliteral">&#39;6&#39;</span>}, {<span class="charliteral">&#39;P&#39;</span>, <span class="charliteral">&#39;0&#39;</span>}, {<span class="charliteral">&#39;Q&#39;</span>, <span class="charliteral">&#39;1&#39;</span>},</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> {<span class="charliteral">&#39;O&#39;</span>, <span class="charliteral">&#39;9&#39;</span>}, {<span class="charliteral">&#39;B&#39;</span>, <span class="charliteral">&#39;?&#39;</span>}, {<span class="charliteral">&#39;G&#39;</span>, <span class="charliteral">&#39;&amp;&#39;</span>}, {0x7F, 0x7F}, {<span class="charliteral">&#39;M&#39;</span>, <span class="charliteral">&#39;.&#39;</span>}, {<span class="charliteral">&#39;X&#39;</span>, <span class="charliteral">&#39;/&#39;</span>}, {<span class="charliteral">&#39;V&#39;</span>, <span class="charliteral">&#39;;&#39;</span>}, {0x7F, 0x7F}</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>};</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="foldopen" id="foldopen00024" data-start="{" data-end="};">
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="class_i_t_a2_string.html"> 24</a></span><span class="keyword">class </span><a class="code hl_class" href="class_i_t_a2_string.html">ITA2String</a> {</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">explicit</span> <a class="code hl_class" href="class_i_t_a2_string.html">ITA2String</a>(<span class="keywordtype">char</span> c);</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">explicit</span> <a class="code hl_class" href="class_i_t_a2_string.html">ITA2String</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* str);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_class" href="class_i_t_a2_string.html">ITA2String</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_i_t_a2_string.html">ITA2String</a>&amp; ita2);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <a class="code hl_class" href="class_i_t_a2_string.html">ITA2String</a>&amp; <a class="code hl_function" href="class_i_t_a2_string.html#a8b572c54ca3fdd1d8ba7ef6ec0dfd384">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_i_t_a2_string.html">ITA2String</a>&amp; ita2);</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <a class="code hl_function" href="class_i_t_a2_string.html#afde24c931997581878953660192e09a2">~ITA2String</a>();</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="class_i_t_a2_string.html#a79b48f6e1eab664b841f3fd20c333e8e">length</a>();</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> uint8_t* <a class="code hl_function" href="class_i_t_a2_string.html#a3f42f7ad98473dbe36515e676622ed3d">byteArr</a>();</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="preprocessor"> #if RADIOLIB_STATIC_ONLY</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keywordtype">char</span> strAscii[RADIOLIB_STATIC_ARRAY_SIZE];</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="preprocessor"> #else</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keywordtype">char</span>* strAscii;</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="preprocessor"> #endif</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keywordtype">size_t</span> asciiLen;</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keywordtype">size_t</span> ita2Len;</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">static</span> uint16_t getBits(<span class="keywordtype">char</span> c);</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span>};</div>
</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclass_i_t_a2_string_html"><div class="ttname"><a href="class_i_t_a2_string.html">ITA2String</a></div><div class="ttdoc">ITA2-encoded string.</div><div class="ttdef"><b>Definition</b> ITA2String.h:24</div></div>
<div class="ttc" id="aclass_i_t_a2_string_html_a3f42f7ad98473dbe36515e676622ed3d"><div class="ttname"><a href="class_i_t_a2_string.html#a3f42f7ad98473dbe36515e676622ed3d">ITA2String::byteArr</a></div><div class="ttdeci">uint8_t * byteArr()</div><div class="ttdoc">Gets the ITA2 representation of the ASCII string set in constructor.</div><div class="ttdef"><b>Definition</b> ITA2String.cpp:62</div></div>
<div class="ttc" id="aclass_i_t_a2_string_html_a79b48f6e1eab664b841f3fd20c333e8e"><div class="ttname"><a href="class_i_t_a2_string.html#a79b48f6e1eab664b841f3fd20c333e8e">ITA2String::length</a></div><div class="ttdeci">size_t length()</div><div class="ttdoc">Gets the length of the ITA2 string. This number is not the same as the length of ASCII-encoded string...</div><div class="ttdef"><b>Definition</b> ITA2String.cpp:50</div></div>
<div class="ttc" id="aclass_i_t_a2_string_html_a8b572c54ca3fdd1d8ba7ef6ec0dfd384"><div class="ttname"><a href="class_i_t_a2_string.html#a8b572c54ca3fdd1d8ba7ef6ec0dfd384">ITA2String::operator=</a></div><div class="ttdeci">ITA2String &amp; operator=(const ITA2String &amp;ita2)</div><div class="ttdoc">Overload for assignment operator.</div><div class="ttdef"><b>Definition</b> ITA2String.cpp:32</div></div>
<div class="ttc" id="aclass_i_t_a2_string_html_afde24c931997581878953660192e09a2"><div class="ttname"><a href="class_i_t_a2_string.html#afde24c931997581878953660192e09a2">ITA2String::~ITA2String</a></div><div class="ttdeci">~ITA2String()</div><div class="ttdoc">Default destructor.</div><div class="ttdef"><b>Definition</b> ITA2String.cpp:44</div></div>
</div><!-- fragment --></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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_79690749eba542503bb1a9a3dbb495e1.html">protocols</a></li><li class="navelem"><a class="el" href="dir_2248554564c3ddf80e1cd7e195a7aaf0.html">Print</a></li><li class="navelem"><b>ITA2String.h</b></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>