athena/structathena_1_1io_1_1_buff...

246 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.11"/>
<title>Athena IO Library: athena::io::Buffer&lt; sizeVar, VE &gt; Struct Template 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/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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Athena IO Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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 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">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;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('structathena_1_1io_1_1_buffer.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)">
</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="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structathena_1_1io_1_1_buffer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">athena::io::Buffer&lt; sizeVar, VE &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Concrete buffer type used by <a class="el" href="structathena_1_1io_1_1_d_n_a.html#a9b0fc9b799276a3f0ad218cb01cdcb67" title="Template type wrapping std::unique_ptr&lt;atUint8[]&gt; and signaling atdna to read a raw byte-buffer where...">DNA::Buffer</a>.
<a href="structathena_1_1io_1_1_buffer.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_d_n_a_8hpp_source.html">DNA.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for athena::io::Buffer&lt; sizeVar, VE &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structathena_1_1io_1_1_buffer__inherit__graph.png" border="0" usemap="#athena_1_1io_1_1_buffer_3_01size_var_00_01_v_e_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="athena_1_1io_1_1_buffer_3_01size_var_00_01_v_e_01_4_inherit__map" id="athena_1_1io_1_1_buffer_3_01size_var_00_01_v_e_01_4_inherit__map">
<area shape="rect" id="node2" href="structathena_1_1io_1_1_d_n_a.html" title="{athena::io::DNA\&lt; VE \&gt;\n||+ ~DNA()\l+ read()\l+ write()\l+ binarySize()\l+ __EnumerateSize()\l}" alt="" coords="5,5,176,141"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for athena::io::Buffer&lt; sizeVar, VE &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structathena_1_1io_1_1_buffer__coll__graph.png" border="0" usemap="#athena_1_1io_1_1_buffer_3_01size_var_00_01_v_e_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="athena_1_1io_1_1_buffer_3_01size_var_00_01_v_e_01_4_coll__map" id="athena_1_1io_1_1_buffer_3_01size_var_00_01_v_e_01_4_coll__map">
<area shape="rect" id="node2" href="structathena_1_1io_1_1_d_n_a.html" title="{athena::io::DNA\&lt; VE \&gt;\n||+ ~DNA()\l+ read()\l+ write()\l+ binarySize()\l+ __EnumerateSize()\l}" alt="" coords="5,5,176,141"/>
</map>
</div>
<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:a6f04023324a82e215b0412fcf2512b91"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f04023324a82e215b0412fcf2512b91"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structathena_1_1io_1_1_buffer.html#a6f04023324a82e215b0412fcf2512b91">read</a> (<a class="el" href="classathena_1_1io_1_1_i_stream_reader.html">IStreamReader</a> &amp;reader)</td></tr>
<tr class="memdesc:a6f04023324a82e215b0412fcf2512b91"><td class="mdescLeft">&#160;</td><td class="mdescRight">Common virtual read function for all <a class="el" href="structathena_1_1io_1_1_d_n_a.html" title="Base DNA class used against &#39;atdna&#39;. ">DNA</a> types. <br /></td></tr>
<tr class="separator:a6f04023324a82e215b0412fcf2512b91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d71dc4060e9ce600fb7eaf62c3b7318"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1d71dc4060e9ce600fb7eaf62c3b7318"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structathena_1_1io_1_1_buffer.html#a1d71dc4060e9ce600fb7eaf62c3b7318">write</a> (<a class="el" href="classathena_1_1io_1_1_i_stream_writer.html">IStreamWriter</a> &amp;writer) const </td></tr>
<tr class="memdesc:a1d71dc4060e9ce600fb7eaf62c3b7318"><td class="mdescLeft">&#160;</td><td class="mdescRight">Common virtual write function for all <a class="el" href="structathena_1_1io_1_1_d_n_a.html" title="Base DNA class used against &#39;atdna&#39;. ">DNA</a> types. <br /></td></tr>
<tr class="separator:a1d71dc4060e9ce600fb7eaf62c3b7318"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c2f462edb3e08337b94ad7ab5c2f2c6"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structathena_1_1io_1_1_buffer.html#a9c2f462edb3e08337b94ad7ab5c2f2c6">binarySize</a> (size_t __isz) const </td></tr>
<tr class="memdesc:a9c2f462edb3e08337b94ad7ab5c2f2c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Common virtual binary size computation for all <a class="el" href="structathena_1_1io_1_1_d_n_a.html" title="Base DNA class used against &#39;atdna&#39;. ">DNA</a> types. <a href="#a9c2f462edb3e08337b94ad7ab5c2f2c6">More...</a><br /></td></tr>
<tr class="separator:a9c2f462edb3e08337b94ad7ab5c2f2c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a2425db22065681d8b13fbfb6f024f595"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2425db22065681d8b13fbfb6f024f595"></a>
<a class="el" href="structathena_1_1io_1_1_d_n_a.html">DNA</a>&lt; VE &gt;::Delete&#160;</td><td class="memItemRight" valign="bottom"><b>expl</b></td></tr>
<tr class="separator:a2425db22065681d8b13fbfb6f024f595"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_structathena_1_1io_1_1_d_n_a"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structathena_1_1io_1_1_d_n_a')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="structathena_1_1io_1_1_d_n_a.html">athena::io::DNA&lt; VE &gt;</a></td></tr>
<tr class="memitem:ae3064c2a8e289c5020037c5593e2b008 inherit pub_types_structathena_1_1io_1_1_d_n_a"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structathena_1_1io_1_1_d_n_a.html#ae3064c2a8e289c5020037c5593e2b008">Value</a> = T</td></tr>
<tr class="memdesc:ae3064c2a8e289c5020037c5593e2b008 inherit pub_types_structathena_1_1io_1_1_d_n_a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Template type signaling atdna to capture the value where it's used. <a href="#ae3064c2a8e289c5020037c5593e2b008">More...</a><br /></td></tr>
<tr class="separator:ae3064c2a8e289c5020037c5593e2b008 inherit pub_types_structathena_1_1io_1_1_d_n_a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5852dadd55deeca4f56f0cffb131f477 inherit pub_types_structathena_1_1io_1_1_d_n_a"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structathena_1_1io_1_1_d_n_a.html#a5852dadd55deeca4f56f0cffb131f477">Vector</a> = std::vector&lt; T &gt;</td></tr>
<tr class="memdesc:a5852dadd55deeca4f56f0cffb131f477 inherit pub_types_structathena_1_1io_1_1_d_n_a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Template type wrapping std::vector and signaling atdna to manipulate it where it's used. <a href="#a5852dadd55deeca4f56f0cffb131f477">More...</a><br /></td></tr>
<tr class="separator:a5852dadd55deeca4f56f0cffb131f477 inherit pub_types_structathena_1_1io_1_1_d_n_a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b0fc9b799276a3f0ad218cb01cdcb67 inherit pub_types_structathena_1_1io_1_1_d_n_a"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structathena_1_1io_1_1_d_n_a.html#a9b0fc9b799276a3f0ad218cb01cdcb67">Buffer</a> = struct <a class="el" href="structathena_1_1io_1_1_buffer.html">athena::io::Buffer</a>&lt; sizeVar, DNAE &gt;</td></tr>
<tr class="memdesc:a9b0fc9b799276a3f0ad218cb01cdcb67 inherit pub_types_structathena_1_1io_1_1_d_n_a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Template type wrapping std::unique_ptr&lt;atUint8[]&gt; and signaling atdna to read a raw byte-buffer where it's used. <a href="#a9b0fc9b799276a3f0ad218cb01cdcb67">More...</a><br /></td></tr>
<tr class="separator:a9b0fc9b799276a3f0ad218cb01cdcb67 inherit pub_types_structathena_1_1io_1_1_d_n_a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00c28a9622f6cc5ccb42e3a1d203ff1d inherit pub_types_structathena_1_1io_1_1_d_n_a"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structathena_1_1io_1_1_d_n_a.html#a00c28a9622f6cc5ccb42e3a1d203ff1d">String</a> = struct <a class="el" href="structathena_1_1io_1_1_string.html">athena::io::String</a>&lt; sizeVar, DNAE &gt;</td></tr>
<tr class="memdesc:a00c28a9622f6cc5ccb42e3a1d203ff1d inherit pub_types_structathena_1_1io_1_1_d_n_a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Template type wrapping std::string and signaling atdna to read string data where it's used. <a href="#a00c28a9622f6cc5ccb42e3a1d203ff1d">More...</a><br /></td></tr>
<tr class="separator:a00c28a9622f6cc5ccb42e3a1d203ff1d inherit pub_types_structathena_1_1io_1_1_d_n_a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2819c34f3b571308213d78d5d6d4d3c inherit pub_types_structathena_1_1io_1_1_d_n_a"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structathena_1_1io_1_1_d_n_a.html#aa2819c34f3b571308213d78d5d6d4d3c">WString</a> = struct <a class="el" href="structathena_1_1io_1_1_w_string.html">athena::io::WString</a>&lt; sizeVar, VE &gt;</td></tr>
<tr class="memdesc:aa2819c34f3b571308213d78d5d6d4d3c inherit pub_types_structathena_1_1io_1_1_d_n_a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Template type wrapping std::wstring and signaling atdna to read wstring data where it's used. <a href="#aa2819c34f3b571308213d78d5d6d4d3c">More...</a><br /></td></tr>
<tr class="separator:aa2819c34f3b571308213d78d5d6d4d3c inherit pub_types_structathena_1_1io_1_1_d_n_a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af39bd99243038fefee2390dca0de760d inherit pub_types_structathena_1_1io_1_1_d_n_a"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structathena_1_1io_1_1_d_n_a.html#af39bd99243038fefee2390dca0de760d">WStringAsString</a> = struct <a class="el" href="structathena_1_1io_1_1_w_string_as_string.html">athena::io::WStringAsString</a>&lt; sizeVar, DNAE &gt;</td></tr>
<tr class="memdesc:af39bd99243038fefee2390dca0de760d inherit pub_types_structathena_1_1io_1_1_d_n_a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Template type wrapping std::string and signaling atdna to read wstring data where it's used. <a href="#af39bd99243038fefee2390dca0de760d">More...</a><br /></td></tr>
<tr class="separator:af39bd99243038fefee2390dca0de760d inherit pub_types_structathena_1_1io_1_1_d_n_a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_static_methods_structathena_1_1io_1_1_d_n_a"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_structathena_1_1io_1_1_d_n_a')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="structathena_1_1io_1_1_d_n_a.html">athena::io::DNA&lt; VE &gt;</a></td></tr>
<tr class="memitem:aba07c0082c48d919ade16f09a37a19be inherit pub_static_methods_structathena_1_1io_1_1_d_n_a"><td class="memItemLeft" align="right" valign="top">static size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structathena_1_1io_1_1_d_n_a.html#aba07c0082c48d919ade16f09a37a19be">__EnumerateSize</a> (size_t __isz, const T &amp;v)</td></tr>
<tr class="memdesc:aba07c0082c48d919ade16f09a37a19be inherit pub_static_methods_structathena_1_1io_1_1_d_n_a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal DNA helper for accumulating binarySize. <a href="#aba07c0082c48d919ade16f09a37a19be">More...</a><br /></td></tr>
<tr class="separator:aba07c0082c48d919ade16f09a37a19be inherit pub_static_methods_structathena_1_1io_1_1_d_n_a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;size_t sizeVar, Endian VE&gt;<br />
struct athena::io::Buffer&lt; sizeVar, VE &gt;</h3>
<p>Concrete buffer type used by <a class="el" href="structathena_1_1io_1_1_d_n_a.html#a9b0fc9b799276a3f0ad218cb01cdcb67" title="Template type wrapping std::unique_ptr&lt;atUint8[]&gt; and signaling atdna to read a raw byte-buffer where...">DNA::Buffer</a>. </p>
<p>Definition at line <a class="el" href="_d_n_a_8hpp_source.html#l00024">24</a> of file <a class="el" href="_d_n_a_8hpp_source.html">DNA.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a9c2f462edb3e08337b94ad7ab5c2f2c6"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t sizeVar, Endian VE&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="structathena_1_1io_1_1_buffer.html">athena::io::Buffer</a>&lt; sizeVar, VE &gt;::binarySize </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>__isz</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Common virtual binary size computation for all <a class="el" href="structathena_1_1io_1_1_d_n_a.html" title="Base DNA class used against &#39;atdna&#39;. ">DNA</a> types. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">__isz</td><td>initial cumulative value to add result to </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Cumulative size </dd></dl>
<p>Implements <a class="el" href="structathena_1_1io_1_1_d_n_a.html#a90e83466b25b80739ac7e001070e984e">athena::io::DNA&lt; VE &gt;</a>.</p>
<p>Definition at line <a class="el" href="_d_n_a_8hpp_source.html#l00164">164</a> of file <a class="el" href="_d_n_a_8hpp_source.html">DNA.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/athena/<a class="el" href="_d_n_a_8hpp_source.html">DNA.hpp</a></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"><b>athena</b></li><li class="navelem"><b>io</b></li><li class="navelem"><a class="el" href="structathena_1_1io_1_1_buffer.html">Buffer</a></li>
<li class="footer">Generated on Sat Sep 17 2016 13:10:08 for Athena IO Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>