190 lines
16 KiB
HTML
190 lines
16 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>PIP: PIChunkStream 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="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">PIP
|
|
 <span id="projectnumber">0.5.0_alpha</span>
|
|
</div>
|
|
<div id="projectbrief">Platform-Independent Primitives</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- 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>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<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>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</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">
|
|
$(document).ready(function(){initNavTree('class_p_i_chunk_stream.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="class_p_i_chunk_stream-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">PIChunkStream Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Class for binary serialization.
|
|
<a href="class_p_i_chunk_stream.html#details">More...</a></p>
|
|
<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:a9b0680f7b75f247a5fc4c9d366edf43f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9b0680f7b75f247a5fc4c9d366edf43f"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_chunk_stream.html#a9b0680f7b75f247a5fc4c9d366edf43f">PIChunkStream</a> (const <a class="el" href="class_p_i_byte_array.html">PIByteArray</a> &<a class="el" href="class_p_i_chunk_stream.html#a2bd23c1b3d63a34e26fb272c3ffd68cc">data</a>)</td></tr>
|
|
<tr class="memdesc:a9b0680f7b75f247a5fc4c9d366edf43f"><td class="mdescLeft"> </td><td class="mdescRight">Contructs stream for read from "data". <br /></td></tr>
|
|
<tr class="separator:a9b0680f7b75f247a5fc4c9d366edf43f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a604f6dc1e095daa47442320ffa6b944b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a604f6dc1e095daa47442320ffa6b944b"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_chunk_stream.html#a604f6dc1e095daa47442320ffa6b944b">PIChunkStream</a> (<a class="el" href="class_p_i_byte_array.html">PIByteArray</a> *<a class="el" href="class_p_i_chunk_stream.html#a2bd23c1b3d63a34e26fb272c3ffd68cc">data</a>=0)</td></tr>
|
|
<tr class="memdesc:a604f6dc1e095daa47442320ffa6b944b"><td class="mdescLeft"> </td><td class="mdescRight">Contructs stream for read or write to/from "data", or empty stream for write. <br /></td></tr>
|
|
<tr class="separator:a604f6dc1e095daa47442320ffa6b944b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2bd23c1b3d63a34e26fb272c3ffd68cc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2bd23c1b3d63a34e26fb272c3ffd68cc"></a>
|
|
<a class="el" href="class_p_i_byte_array.html">PIByteArray</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_chunk_stream.html#a2bd23c1b3d63a34e26fb272c3ffd68cc">data</a> () const </td></tr>
|
|
<tr class="memdesc:a2bd23c1b3d63a34e26fb272c3ffd68cc"><td class="mdescLeft"> </td><td class="mdescRight">Returns internal buffer with written data. <br /></td></tr>
|
|
<tr class="separator:a2bd23c1b3d63a34e26fb272c3ffd68cc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa9da42274d96d44d19eaf2d7aefc4bba"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9da42274d96d44d19eaf2d7aefc4bba"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_chunk_stream.html#aa9da42274d96d44d19eaf2d7aefc4bba">atEnd</a> () const </td></tr>
|
|
<tr class="memdesc:aa9da42274d96d44d19eaf2d7aefc4bba"><td class="mdescLeft"> </td><td class="mdescRight">Returns if there is end of stream. <br /></td></tr>
|
|
<tr class="separator:aa9da42274d96d44d19eaf2d7aefc4bba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac7f7588cf308dd128b6fdd8ac678cceb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac7f7588cf308dd128b6fdd8ac678cceb"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_chunk_stream.html#ac7f7588cf308dd128b6fdd8ac678cceb">read</a> ()</td></tr>
|
|
<tr class="memdesc:ac7f7588cf308dd128b6fdd8ac678cceb"><td class="mdescLeft"> </td><td class="mdescRight">Read one chunk from stream and returns its ID. <br /></td></tr>
|
|
<tr class="separator:ac7f7588cf308dd128b6fdd8ac678cceb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae50f13503bcff6cce8f5d8c6984595c1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae50f13503bcff6cce8f5d8c6984595c1"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_p_i_chunk_stream.html#ae50f13503bcff6cce8f5d8c6984595c1">getID</a> ()</td></tr>
|
|
<tr class="memdesc:ae50f13503bcff6cce8f5d8c6984595c1"><td class="mdescLeft"> </td><td class="mdescRight">Returns last readed chunk ID. <br /></td></tr>
|
|
<tr class="separator:ae50f13503bcff6cce8f5d8c6984595c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abac68c1cc18309fc65459e2e86020c91"><td class="memTemplParams" colspan="2"><a class="anchor" id="abac68c1cc18309fc65459e2e86020c91"></a>
|
|
template<typename T > </td></tr>
|
|
<tr class="memitem:abac68c1cc18309fc65459e2e86020c91"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_p_i_chunk_stream.html#abac68c1cc18309fc65459e2e86020c91">getData</a> () const </td></tr>
|
|
<tr class="memdesc:abac68c1cc18309fc65459e2e86020c91"><td class="mdescLeft"> </td><td class="mdescRight">Returns value of last readed chunk. <br /></td></tr>
|
|
<tr class="separator:abac68c1cc18309fc65459e2e86020c91"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:aa53cc70261d65c9476980ba21ec1f933"><td class="memTemplParams" colspan="2"><a class="anchor" id="aa53cc70261d65c9476980ba21ec1f933"></a>
|
|
template<typename T > </td></tr>
|
|
<tr class="memitem:aa53cc70261d65c9476980ba21ec1f933"><td class="memTemplItemLeft" align="right" valign="top">static Chunk< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_p_i_chunk_stream.html#aa53cc70261d65c9476980ba21ec1f933">chunk</a> (int id, const T &<a class="el" href="class_p_i_chunk_stream.html#a2bd23c1b3d63a34e26fb272c3ffd68cc">data</a>)</td></tr>
|
|
<tr class="memdesc:aa53cc70261d65c9476980ba21ec1f933"><td class="mdescLeft"> </td><td class="mdescRight">Returns chunk with ID "id" and value "data" for write to stream. <br /></td></tr>
|
|
<tr class="separator:aa53cc70261d65c9476980ba21ec1f933"><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 for binary serialization. </p>
|
|
<h1><a class="anchor" id="PIChunkStream_sec0"></a>
|
|
Synopsis</h1>
|
|
<p>This class provides very handly mechanism to store and restore values to and from <em><a class="el" href="class_p_i_byte_array.html" title="Byte array. ">PIByteArray</a></em>. The main advantage of using this class is that your binary data become independent from order and collection of your values.</p>
|
|
<h1><a class="anchor" id="PIChunkStream_sec1"></a>
|
|
Mechanism</h1>
|
|
<p>PIChunkStream works with items called "chunk". Chunk is an ID and any value that can be stored and restored to <em><a class="el" href="class_p_i_byte_array.html" title="Byte array. ">PIByteArray</a></em> with stream operators << and >>. You can place chunks to stream and read chunks from stream.</p>
|
|
<p>To construct PIChunkStream for writing data use any constructor. Empty constructor creates internal empty buffer that can be accessed by function <em><a class="el" href="class_p_i_chunk_stream.html#a2bd23c1b3d63a34e26fb272c3ffd68cc" title="Returns internal buffer with written data. ">data()</a></em>. Non-empty constructor works with given byte array.</p>
|
|
<p>To read chunks from byte array use function <em><a class="el" href="class_p_i_chunk_stream.html#ac7f7588cf308dd128b6fdd8ac678cceb" title="Read one chunk from stream and returns its ID. ">read()</a></em> that returns ID of next chunk. Then you can get value of this chunk with function <em><a class="el" href="class_p_i_chunk_stream.html#abac68c1cc18309fc65459e2e86020c91" title="Returns value of last readed chunk. ">getData()</a></em>, but you should definitely know type of this value. You can read from byte array while <em><a class="el" href="class_p_i_chunk_stream.html#aa9da42274d96d44d19eaf2d7aefc4bba" title="Returns if there is end of stream. ">atEnd()</a></em> if false.</p>
|
|
<h1><a class="anchor" id="PIChunkStream_ex0"></a>
|
|
Example</h1>
|
|
<p>Prepare your structs to work with PIChunkStream </p><div class="fragment"><div class="line"><span class="comment">// Your struct</span></div>
|
|
<div class="line"><span class="keyword">struct </span>S {</div>
|
|
<div class="line"> <span class="keywordtype">int</span> i;</div>
|
|
<div class="line"> <span class="keywordtype">float</span> f;</div>
|
|
<div class="line"> <a class="code" href="class_p_i_string.html">PIString</a> s;</div>
|
|
<div class="line">};</div>
|
|
<div class="line"></div>
|
|
<div class="line"><span class="comment">// Operators</span></div>
|
|
<div class="line"><a class="code" href="class_p_i_byte_array.html">PIByteArray</a> & operator <<(<a class="code" href="class_p_i_byte_array.html">PIByteArray</a> & b, <span class="keyword">const</span> S & s) {b << s.i << s.f << s.s; <span class="keywordflow">return</span> b;}</div>
|
|
<div class="line"><a class="code" href="class_p_i_byte_array.html">PIByteArray</a> & operator >>(<a class="code" href="class_p_i_byte_array.html">PIByteArray</a> & b, S & s) {b >> s.i >> s.f >> s.s; <span class="keywordflow">return</span> b;}</div>
|
|
</div><!-- fragment --><p>Writing to PIChunkStream </p><div class="fragment"><div class="line"><span class="comment">// Write chunk stream</span></div>
|
|
<div class="line">S s;</div>
|
|
<div class="line">s.i = 99;</div>
|
|
<div class="line">s.f = 0.01;</div>
|
|
<div class="line">s.s = <span class="stringliteral">"SSS"</span>;</div>
|
|
<div class="line"><a class="code" href="class_p_i_vector.html">PIVector<float></a> f;</div>
|
|
<div class="line">f << -1. << 2.5 << 11.;</div>
|
|
<div class="line"><span class="comment">// write some data to empty stream</span></div>
|
|
<div class="line"><a class="code" href="class_p_i_chunk_stream.html">PIChunkStream</a> cs;</div>
|
|
<div class="line">cs << cs.<a class="code" href="class_p_i_chunk_stream.html#aa53cc70261d65c9476980ba21ec1f933">chunk</a>(1, <span class="keywordtype">int</span>(10))</div>
|
|
<div class="line"> << cs.<a class="code" href="class_p_i_chunk_stream.html#aa53cc70261d65c9476980ba21ec1f933">chunk</a>(2, <a class="code" href="class_p_i_string.html">PIString</a>(<span class="stringliteral">"text"</span>))</div>
|
|
<div class="line"> << cs.<a class="code" href="class_p_i_chunk_stream.html#aa53cc70261d65c9476980ba21ec1f933">chunk</a>(4, f)</div>
|
|
<div class="line"> << cs.<a class="code" href="class_p_i_chunk_stream.html#aa53cc70261d65c9476980ba21ec1f933">chunk</a>(3, s);</div>
|
|
<div class="line"><span class="comment">// now you can take cs.data() and send or place it somewhere ...</span></div>
|
|
</div><!-- fragment --><p>Reading from PIChunkStream </p><div class="fragment"><div class="line"><span class="comment">// create stream for read, cs from upper code</span></div>
|
|
<div class="line"><a class="code" href="class_p_i_byte_array.html">PIByteArray</a> ba(cs.<a class="code" href="class_p_i_chunk_stream.html#a2bd23c1b3d63a34e26fb272c3ffd68cc">data</a>());</div>
|
|
<div class="line"><a class="code" href="class_p_i_chunk_stream.html">PIChunkStream</a> cs2(ba);</div>
|
|
<div class="line"><span class="keywordtype">int</span> i(0);</div>
|
|
<div class="line"><a class="code" href="class_p_i_string.html">PIString</a> str;</div>
|
|
<div class="line">S s;</div>
|
|
<div class="line"><a class="code" href="class_p_i_vector.html">PIVector<float></a> f;</div>
|
|
<div class="line"><span class="comment">// read from stream</span></div>
|
|
<div class="line"><span class="keywordflow">while</span> (!cs2.atEnd()) {</div>
|
|
<div class="line"> <span class="keywordflow">switch</span> (cs2.read()) {</div>
|
|
<div class="line"> <span class="keywordflow">case</span> 1: i = cs2.getData<<span class="keywordtype">int</span>>(); <span class="keywordflow">break</span>;</div>
|
|
<div class="line"> <span class="keywordflow">case</span> 2: str = cs2.getData<<a class="code" href="class_p_i_string.html">PIString</a>>(); <span class="keywordflow">break</span>;</div>
|
|
<div class="line"> <span class="keywordflow">case</span> 3: s = cs2.getData<S>(); <span class="keywordflow">break</span>;</div>
|
|
<div class="line"> <span class="keywordflow">case</span> 4: f = cs2.getData<<a class="code" href="class_p_i_vector.html">PIVector<float></a> >(); <span class="keywordflow">break</span>;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line">}</div>
|
|
<div class="line"><a class="code" href="picout_8h.html#ad21862cbba89aead064fbef4c825030e">piCout</a> << i << str << f << s.i << s.f << s.s;</div>
|
|
</div><!-- fragment --></div></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_p_i_chunk_stream.html">PIChunkStream</a></li>
|
|
<li class="footer">Generated on Sat Jan 30 2016 21:43:28 for PIP by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|