version 0.5.0_alpha
git-svn-id: svn://db.shs.com.ru/pip@8 12ceb7fc-bf1f-11e4-8940-5bc7170c53b5
This commit is contained in:
@@ -3,23 +3,19 @@
|
||||
<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.8"/>
|
||||
<meta name="generator" content="Doxygen 1.8.9.1"/>
|
||||
<title>PIP: PIByteArray 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>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(initResizable);
|
||||
$(window).load(resizeHeight);
|
||||
</script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
||||
</script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
@@ -30,7 +26,7 @@
|
||||
<tr style="height: 56px;">
|
||||
<td style="padding-left: 0.5em;">
|
||||
<div id="projectname">PIP
|
||||
 <span id="projectnumber">0.4.1_alpha3</span>
|
||||
 <span id="projectnumber">0.5.0_prealpha</span>
|
||||
</div>
|
||||
<div id="projectbrief">Platform-Independent Primitives</div>
|
||||
</td>
|
||||
@@ -39,10 +35,7 @@
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.8 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
</script>
|
||||
<!-- Generated by Doxygen 1.8.9.1 -->
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
@@ -50,22 +43,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
<li><a href="namespaces.html"><span>Namespaces</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">
|
||||
@@ -91,20 +68,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
$(document).ready(function(){initNavTree('class_p_i_byte_array.html','');});
|
||||
</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)">
|
||||
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></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> |
|
||||
@@ -385,14 +348,14 @@ Usage</h1>
|
||||
<div class="line"><span class="keywordtype">float</span> f = 1.;</div>
|
||||
<div class="line"><a class="code" href="class_p_i_string.html">PIString</a> text(<span class="stringliteral">"123"</span>);</div>
|
||||
<div class="line">ba << i << j << f << text; <span class="comment">// form binary data</span></div>
|
||||
<div class="line"><a class="code" href="piincludes_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << <span class="stringliteral">"data ="</span> << ba;</div>
|
||||
<div class="line"><a class="code" href="picout_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << <span class="stringliteral">"data ="</span> << ba;</div>
|
||||
<div class="line">i = j = 0; <span class="comment">// clear variables</span></div>
|
||||
<div class="line">f = 0; <span class="comment">// clear variables</span></div>
|
||||
<div class="line">text.clear(); <span class="comment">// clear variables</span></div>
|
||||
<div class="line"><a class="code" href="piincludes_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << i << j << f << text; <span class="comment">// show variables</span></div>
|
||||
<div class="line"><a class="code" href="picout_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << i << j << f << text; <span class="comment">// show variables</span></div>
|
||||
<div class="line">ba >> i >> j >> f >> text; <span class="comment">// restore data</span></div>
|
||||
<div class="line"><a class="code" href="piincludes_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << i << j << f << text; <span class="comment">// show variables</span></div>
|
||||
<div class="line"><a class="code" href="piincludes_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << <span class="stringliteral">"data ="</span> << ba;</div>
|
||||
<div class="line"><a class="code" href="picout_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << i << j << f << text; <span class="comment">// show variables</span></div>
|
||||
<div class="line"><a class="code" href="picout_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << <span class="stringliteral">"data ="</span> << ba;</div>
|
||||
</div><!-- fragment --><p> Or you can descibe stream operator of your own type and store/restore vectors of your type: </p><div class="fragment"><div class="line"><span class="keyword">struct </span>MyType {</div>
|
||||
<div class="line"> MyType(<span class="keywordtype">int</span> i_ = 0, <span class="keyword">const</span> <a class="code" href="class_p_i_string.html">PIString</a> & t_ = <a class="code" href="class_p_i_string.html">PIString</a>()) {</div>
|
||||
<div class="line"> m_i = i_;</div>
|
||||
@@ -409,29 +372,29 @@ Usage</h1>
|
||||
<div class="line"><a class="code" href="class_p_i_vector.html">PIVector<MyType></a> my_vec;</div>
|
||||
<div class="line">my_vec << MyType(1, <span class="stringliteral">"s1"</span>) << MyType(10, <span class="stringliteral">"s10"</span>); <span class="comment">// add to vector</span></div>
|
||||
<div class="line">ba << my_vec; <span class="comment">// store to byte array</span></div>
|
||||
<div class="line"><a class="code" href="piincludes_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << <span class="stringliteral">"data ="</span> << ba;</div>
|
||||
<div class="line"><a class="code" href="picout_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << <span class="stringliteral">"data ="</span> << ba;</div>
|
||||
<div class="line">my_vec.clear(); <span class="comment">// clear vector</span></div>
|
||||
<div class="line">ba >> my_vec; <span class="comment">// restore from byte array</span></div>
|
||||
</div><!-- fragment --><p> For store/restore custom data blocks there is <a class="el" href="struct_p_i_byte_array_1_1_raw_data.html" title="Help struct to store/restore custom blocks of data to/from PIByteArray. ">PIByteArray::RawData</a> class. Stream operators of this class simply store/restore data block to/from byte array. </p><div class="fragment"><div class="line"><a class="code" href="class_p_i_byte_array.html">PIByteArray</a> ba;</div>
|
||||
<div class="line"><span class="keyword">const</span> <span class="keywordtype">char</span> * chars = <span class="stringliteral">"8 bytes"</span>;</div>
|
||||
<div class="line">ba << <a class="code" href="struct_p_i_byte_array_1_1_raw_data.html">PIByteArray::RawData</a>(chars, 8); <span class="comment">// form binary data</span></div>
|
||||
<div class="line"><a class="code" href="piincludes_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << <span class="stringliteral">"data ="</span> << ba;</div>
|
||||
<div class="line"><a class="code" href="picout_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << <span class="stringliteral">"data ="</span> << ba;</div>
|
||||
<div class="line"><span class="keywordtype">char</span> rchars[16];</div>
|
||||
<div class="line">memset(rchars, 0, 16); <span class="comment">// clear data</span></div>
|
||||
<div class="line">ba >> <a class="code" href="struct_p_i_byte_array_1_1_raw_data.html">PIByteArray::RawData</a>(rchars, 8); <span class="comment">// restore data</span></div>
|
||||
<div class="line"><a class="code" href="piincludes_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << rchars;</div>
|
||||
<div class="line"><a class="code" href="piincludes_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << <span class="stringliteral">"data ="</span> << ba;</div>
|
||||
<div class="line"><a class="code" href="picout_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << rchars;</div>
|
||||
<div class="line"><a class="code" href="picout_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << <span class="stringliteral">"data ="</span> << ba;</div>
|
||||
</div><!-- fragment --> <h1><a class="anchor" id="PIByteArray_sec1"></a>
|
||||
Attention</h1>
|
||||
<p>Stream operator of PIByteArray store byte array as vector, not simply append content of byte array. This operators useful to transmit custom data as PIByteArray packed into parent byte array, e.g. to form packet from PIByteArray. To append one byte array to another use funtion <em><a class="el" href="class_p_i_byte_array.html#a3f59d6f9e5aa117ebce88de767bdf6a0" title="Add to the end data "data" with size "size". ">append()</a></em>. </p><div class="fragment"><div class="line"><a class="code" href="class_p_i_byte_array.html">PIByteArray</a> ba, sba;</div>
|
||||
<div class="line">uchar uc(127);</div>
|
||||
<div class="line">sba << uc; <span class="comment">// byte array with one byte</span></div>
|
||||
<div class="line">ba << sba; <span class="comment">// stream operator</span></div>
|
||||
<div class="line"><a class="code" href="piincludes_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << ba; <span class="comment">// result</span></div>
|
||||
<div class="line"><a class="code" href="picout_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << ba; <span class="comment">// result</span></div>
|
||||
<div class="line"><span class="comment">// {1, 0, 0, 0, 127}</span></div>
|
||||
<div class="line">ba.clear();</div>
|
||||
<div class="line">ba.<a class="code" href="class_p_i_byte_array.html#a3f59d6f9e5aa117ebce88de767bdf6a0">append</a>(sba);</div>
|
||||
<div class="line"><a class="code" href="piincludes_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << ba; <span class="comment">// result</span></div>
|
||||
<div class="line"><a class="code" href="picout_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << ba; <span class="comment">// result</span></div>
|
||||
<div class="line"><span class="comment">// {127}</span></div>
|
||||
</div><!-- fragment --></div></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
@@ -439,9 +402,9 @@ Attention</h1>
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="class_p_i_byte_array.html">PIByteArray</a></li>
|
||||
<li class="footer">Generated on Sun Nov 2 2014 22:29:35 for PIP by
|
||||
<li class="footer">Generated on Fri Feb 27 2015 23:03:16 for PIP by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li>
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
Reference in New Issue
Block a user