libAthena
/
athena
mirror of https://github.com/libAthena/athena.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
athena/structathena_1_1io_1_1_d_n_...

481 lines
32 KiB
HTML
Raw Blame History

<!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::DNA&lt; DNAE &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_d_n_a.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="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="structathena_1_1io_1_1_d_n_a-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">athena::io::DNA&lt; DNAE &gt; Struct Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Base <a class="el" href="structathena_1_1io_1_1_d_n_a.html" title="Base DNA class used against &#39;atdna&#39;. ">DNA</a> class used against 'atdna'.
<a href="structathena_1_1io_1_1_d_n_a.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::DNA&lt; DNAE &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structathena_1_1io_1_1_d_n_a__inherit__graph.png" border="0" usemap="#athena_1_1io_1_1_d_n_a_3_01_d_n_a_e_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="athena_1_1io_1_1_d_n_a_3_01_d_n_a_e_01_4_inherit__map" id="athena_1_1io_1_1_d_n_a_3_01_d_n_a_e_01_4_inherit__map">
<area shape="rect" id="node2" href="structathena_1_1io_1_1_d_n_a_yaml.html" title="{athena::io::DNAYaml\l\&lt; DNAE \&gt;\n||+ ~DNAYaml()\l+ read()\l+ write()\l+ DNATypeV()\l+ toYAMLString()\l+ fromYAMLString()\l+ toYAMLStream()\l+ fromYAMLStream()\l+ DNAType()\l+ ValidateFromYAMLString()\l+ ValidateFromYAMLStream()\l}" alt="" coords="37,189,251,428"/>
<area shape="rect" id="node3" href="structathena_1_1io_1_1_d_n_a_yaml.html" title="{DNAYaml\&lt; VE \&gt;\n||+ ~DNAYaml()\l+ read()\l+ write()\l+ DNATypeV()\l+ toYAMLString()\l+ fromYAMLString()\l+ toYAMLStream()\l+ fromYAMLStream()\l+ DNAType()\l+ ValidateFromYAMLString()\l+ ValidateFromYAMLStream()\l}" alt="" coords="275,197,488,421"/>
<area shape="rect" id="node4" href="structathena_1_1io_1_1_buffer_yaml.html" title="{athena::io::BufferYaml\l\&lt; sizeVar, VE \&gt;\n|+ expl\l|+ read()\l+ write()\l+ binarySize()\l+ read()\l+ write()\l}" alt="" coords="5,491,171,641"/>
<area shape="rect" id="node5" href="structathena_1_1io_1_1_string_yaml.html" title="{athena::io::StringYaml\l\&lt; sizeVar, VE \&gt;\n|+ expl\l|+ read()\l+ write()\l+ binarySize()\l+ read()\l+ write()\l+ operator=()\l+ operator=()\l}" alt="" coords="195,476,359,656"/>
<area shape="rect" id="node6" href="structathena_1_1io_1_1_w_string_as_string_yaml.html" title="{athena::io::WStringAsString\lYaml\&lt; sizeVar, VE \&gt;\n|+ expl\l|+ read()\l+ write()\l+ binarySize()\l+ read()\l+ write()\l+ operator=()\l+ operator=()\l}" alt="" coords="384,476,584,656"/>
<area shape="rect" id="node7" href="structathena_1_1io_1_1_w_string_yaml.html" title="{athena::io::WStringYaml\l\&lt; sizeVar, VE \&gt;\n|+ expl\l|+ read()\l+ write()\l+ binarySize()\l+ read()\l+ write()\l+ operator=()\l+ operator=()\l}" alt="" coords="609,476,786,656"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for athena::io::DNA&lt; DNAE &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structathena_1_1io_1_1_d_n_a__coll__graph.png" border="0" usemap="#athena_1_1io_1_1_d_n_a_3_01_d_n_a_e_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="athena_1_1io_1_1_d_n_a_3_01_d_n_a_e_01_4_coll__map" id="athena_1_1io_1_1_d_n_a_3_01_d_n_a_e_01_4_coll__map">
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structathena_1_1io_1_1_d_n_a_1_1_align.html">Align</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Meta Template signaling atdna to insert an aligning stream seek where it's used. <a href="structathena_1_1io_1_1_d_n_a_1_1_align.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structathena_1_1io_1_1_d_n_a_1_1_delete.html">Delete</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Meta Template preventing atdna from emitting read/write implementations. <a href="structathena_1_1io_1_1_d_n_a_1_1_delete.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structathena_1_1io_1_1_d_n_a_1_1_seek.html">Seek</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Meta Template signaling atdna to insert a stream seek where it's used. <a href="structathena_1_1io_1_1_d_n_a_1_1_seek.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ae3064c2a8e289c5020037c5593e2b008"><td class="memTemplParams" colspan="2">template&lt;typename T , Endian VE = DNAE&gt; </td></tr>
<tr class="memitem:ae3064c2a8e289c5020037c5593e2b008"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" 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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5852dadd55deeca4f56f0cffb131f477"><td class="memTemplParams" colspan="2">template&lt;typename T , size_t cntVar, Endian VE = DNAE&gt; </td></tr>
<tr class="memitem:a5852dadd55deeca4f56f0cffb131f477"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" 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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b0fc9b799276a3f0ad218cb01cdcb67"><td class="memTemplParams" colspan="2">template&lt;size_t sizeVar&gt; </td></tr>
<tr class="memitem:a9b0fc9b799276a3f0ad218cb01cdcb67"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" 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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00c28a9622f6cc5ccb42e3a1d203ff1d"><td class="memTemplParams" colspan="2">template&lt;atInt32 sizeVar = -1&gt; </td></tr>
<tr class="memitem:a00c28a9622f6cc5ccb42e3a1d203ff1d"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" 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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2819c34f3b571308213d78d5d6d4d3c"><td class="memTemplParams" colspan="2">template&lt;atInt32 sizeVar = -1, Endian VE = DNAE&gt; </td></tr>
<tr class="memitem:aa2819c34f3b571308213d78d5d6d4d3c"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" 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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af39bd99243038fefee2390dca0de760d"><td class="memTemplParams" colspan="2">template&lt;atInt32 sizeVar = -1&gt; </td></tr>
<tr class="memitem:af39bd99243038fefee2390dca0de760d"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" 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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a1ffe91a70b3120b7307644ecb2a49d66"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ffe91a70b3120b7307644ecb2a49d66"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structathena_1_1io_1_1_d_n_a.html#a1ffe91a70b3120b7307644ecb2a49d66">read</a> (<a class="el" href="classathena_1_1io_1_1_i_stream_reader.html">IStreamReader</a> &amp;)=0</td></tr>
<tr class="memdesc:a1ffe91a70b3120b7307644ecb2a49d66"><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:a1ffe91a70b3120b7307644ecb2a49d66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09693973df2cbdf1304dab0de1627661"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a09693973df2cbdf1304dab0de1627661"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structathena_1_1io_1_1_d_n_a.html#a09693973df2cbdf1304dab0de1627661">write</a> (<a class="el" href="classathena_1_1io_1_1_i_stream_writer.html">IStreamWriter</a> &amp;) const =0</td></tr>
<tr class="memdesc:a09693973df2cbdf1304dab0de1627661"><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:a09693973df2cbdf1304dab0de1627661"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90e83466b25b80739ac7e001070e984e"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structathena_1_1io_1_1_d_n_a.html#a90e83466b25b80739ac7e001070e984e">binarySize</a> (size_t __isz) const =0</td></tr>
<tr class="memdesc:a90e83466b25b80739ac7e001070e984e"><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="#a90e83466b25b80739ac7e001070e984e">More...</a><br /></td></tr>
<tr class="separator:a90e83466b25b80739ac7e001070e984e"><td class="memSeparator" colspan="2">&#160;</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:aba07c0082c48d919ade16f09a37a19be"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:aba07c0082c48d919ade16f09a37a19be"><td class="memTemplItemLeft" align="right" valign="top">static size_t&#160;</td><td class="memTemplItemRight" 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"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal <a class="el" href="structathena_1_1io_1_1_d_n_a.html" title="Base DNA class used against &#39;atdna&#39;. ">DNA</a> helper for accumulating binarySize. <a href="#aba07c0082c48d919ade16f09a37a19be">More...</a><br /></td></tr>
<tr class="separator:aba07c0082c48d919ade16f09a37a19be"><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;Endian DNAE&gt;<br />
struct athena::io::DNA&lt; DNAE &gt;</h3>
<p>Base <a class="el" href="structathena_1_1io_1_1_d_n_a.html" title="Base DNA class used against &#39;atdna&#39;. ">DNA</a> class used against 'atdna'. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">DNAE</td><td>Default-endianness for contained <a class="el" href="structathena_1_1io_1_1_d_n_a.html" title="Base DNA class used against &#39;atdna&#39;. ">DNA</a> values</td></tr>
</table>
</dd>
</dl>
<p>Athena bundles a build-tool called 'atdna'. This tool functions just like the 'clang' compiler, except it emits a full .cpp implementation with all read/write calls necessary to marshal the <a class="el" href="structathena_1_1io_1_1_d_n_a.html" title="Base DNA class used against &#39;atdna&#39;. ">DNA</a> structure to/from a streamed medium </p>
<p>Definition at line <a class="el" href="_d_n_a_8hpp_source.html#l00045">45</a> of file <a class="el" href="_d_n_a_8hpp_source.html">DNA.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a9b0fc9b799276a3f0ad218cb01cdcb67"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;Endian DNAE&gt; </div>
<div class="memtemplate">
template&lt;size_t sizeVar&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="structathena_1_1io_1_1_d_n_a.html">athena::io::DNA</a>&lt; DNAE &gt;::<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>
</table>
</div><div class="memdoc">
<p>Template type wrapping std::unique_ptr&lt;atUint8[]&gt; and signaling atdna to read a raw byte-buffer where it's used. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">sizeVar</td><td>C++ expression wrapped in DNA_COUNT macro to determine number of bytes for buffer </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_d_n_a_8hpp_source.html#l00087">87</a> of file <a class="el" href="_d_n_a_8hpp_source.html">DNA.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a00c28a9622f6cc5ccb42e3a1d203ff1d"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;Endian DNAE&gt; </div>
<div class="memtemplate">
template&lt;atInt32 sizeVar = -1&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="structathena_1_1io_1_1_d_n_a.html">athena::io::DNA</a>&lt; DNAE &gt;::<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>
</table>
</div><div class="memdoc">
<p>Template type wrapping std::string and signaling atdna to read string data where it's used. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">sizeVar</td><td>C++ expression wrapped in DNA_COUNT macro to determine number of characters for string -1 literal indicates null-terminated string </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_d_n_a_8hpp_source.html#l00095">95</a> of file <a class="el" href="_d_n_a_8hpp_source.html">DNA.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae3064c2a8e289c5020037c5593e2b008"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;Endian DNAE&gt; </div>
<div class="memtemplate">
template&lt;typename T , Endian VE = DNAE&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="structathena_1_1io_1_1_d_n_a.html">athena::io::DNA</a>&lt; DNAE &gt;::<a class="el" href="structathena_1_1io_1_1_d_n_a.html#ae3064c2a8e289c5020037c5593e2b008">Value</a> = T</td>
</tr>
</table>
</div><div class="memdoc">
<p>Template type signaling atdna to capture the value where it's used. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>The type of the value. Can be any numeric type or atVec* type </td></tr>
<tr><td class="paramname">VE</td><td>Endianness of the value </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_d_n_a_8hpp_source.html#l00070">70</a> of file <a class="el" href="_d_n_a_8hpp_source.html">DNA.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5852dadd55deeca4f56f0cffb131f477"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;Endian DNAE&gt; </div>
<div class="memtemplate">
template&lt;typename T , size_t cntVar, Endian VE = DNAE&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="structathena_1_1io_1_1_d_n_a.html">athena::io::DNA</a>&lt; DNAE &gt;::<a class="el" href="structathena_1_1io_1_1_d_n_a.html#a5852dadd55deeca4f56f0cffb131f477">Vector</a> = std::vector&lt;T&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Template type wrapping std::vector and signaling atdna to manipulate it where it's used. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>The type of contained elements. Can be any numeric type, atVec* type, or another <a class="el" href="structathena_1_1io_1_1_d_n_a.html" title="Base DNA class used against &#39;atdna&#39;. ">DNA</a> subclass </td></tr>
<tr><td class="paramname">cntVar</td><td>C++ expression wrapped in DNA_COUNT macro to determine number of elements for vector </td></tr>
<tr><td class="paramname">VE</td><td>Endianness of the contained values </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_d_n_a_8hpp_source.html#l00079">79</a> of file <a class="el" href="_d_n_a_8hpp_source.html">DNA.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa2819c34f3b571308213d78d5d6d4d3c"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;Endian DNAE&gt; </div>
<div class="memtemplate">
template&lt;atInt32 sizeVar = -1, Endian VE = DNAE&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="structathena_1_1io_1_1_d_n_a.html">athena::io::DNA</a>&lt; DNAE &gt;::<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>
</table>
</div><div class="memdoc">
<p>Template type wrapping std::wstring and signaling atdna to read wstring data where it's used. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">sizeVar</td><td>C++ expression wrapped in DNA_COUNT macro to determine number of characters for wstring -1 literal indicates null-terminated wstring </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_d_n_a_8hpp_source.html#l00103">103</a> of file <a class="el" href="_d_n_a_8hpp_source.html">DNA.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="af39bd99243038fefee2390dca0de760d"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;Endian DNAE&gt; </div>
<div class="memtemplate">
template&lt;atInt32 sizeVar = -1&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="structathena_1_1io_1_1_d_n_a.html">athena::io::DNA</a>&lt; DNAE &gt;::<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>
</table>
</div><div class="memdoc">
<p>Template type wrapping std::string and signaling atdna to read wstring data where it's used. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">sizeVar</td><td>C++ expression wrapped in DNA_COUNT macro to determine number of characters for string -1 literal indicates null-terminated string </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_d_n_a_8hpp_source.html#l00111">111</a> of file <a class="el" href="_d_n_a_8hpp_source.html">DNA.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aba07c0082c48d919ade16f09a37a19be"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;Endian DNAE&gt; </div>
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static size_t <a class="el" href="structathena_1_1io_1_1_d_n_a.html">athena::io::DNA</a>&lt; DNAE &gt;::__EnumerateSize </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>__isz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>v</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Internal <a class="el" href="structathena_1_1io_1_1_d_n_a.html" title="Base DNA class used against &#39;atdna&#39;. ">DNA</a> helper for accumulating binarySize. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">__isz</td><td>initial size value </td></tr>
<tr><td class="paramname">v</td><td>Vector to enumerate </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Cumulative total </dd></dl>
<p>Definition at line <a class="el" href="_d_n_a_8hpp_source.html#l00140">140</a> of file <a class="el" href="_d_n_a_8hpp_source.html">DNA.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a90e83466b25b80739ac7e001070e984e"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;Endian DNAE&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t <a class="el" href="structathena_1_1io_1_1_d_n_a.html">athena::io::DNA</a>&lt; DNAE &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">pure 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>Implemented in <a class="el" href="structathena_1_1io_1_1_w_string_as_string_yaml.html#a42cf54aa556c7434bdc8ef7b122a6a38">athena::io::WStringAsStringYaml&lt; sizeVar, VE &gt;</a>, <a class="el" href="structathena_1_1io_1_1_w_string_yaml.html#a8c7cf90a1886810379bd7ea671fde7f9">athena::io::WStringYaml&lt; sizeVar, VE &gt;</a>, <a class="el" href="structathena_1_1io_1_1_string_yaml.html#a38b3446cea33f93e04bd0346b128a6a4">athena::io::StringYaml&lt; sizeVar, VE &gt;</a>, <a class="el" href="structathena_1_1io_1_1_buffer_yaml.html#a397e9d5931a71d4cf28181c0c8183c05">athena::io::BufferYaml&lt; sizeVar, VE &gt;</a>, <a class="el" href="structathena_1_1io_1_1_w_string_as_string.html#a0769b8ed22bad841116817058a1f082b">athena::io::WStringAsString&lt; sizeVar, VE &gt;</a>, <a class="el" href="structathena_1_1io_1_1_w_string.html#adba389a039c69a3c6af86381bf2d97ad">athena::io::WString&lt; sizeVar, VE &gt;</a>, <a class="el" href="structathena_1_1io_1_1_string.html#ac37e667786002f38643b6aaedc1b0b7e">athena::io::String&lt; sizeVar, VE &gt;</a>, and <a class="el" href="structathena_1_1io_1_1_buffer.html#a9c2f462edb3e08337b94ad7ab5c2f2c6">athena::io::Buffer&lt; sizeVar, VE &gt;</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_d_n_a.html">DNA</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>
Reference in New Issue View Git Blame Copy Permalink