117 lines
12 KiB
HTML
117 lines
12 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">
|
||
|
<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.4"/>
|
||
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
|
<title>DNA Calib: StreamReader.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="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">DNA Calib<span id="projectnumber"> 1.1</span>
|
||
|
</div>
|
||
|
<div id="projectbrief">Project brief</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
</tbody>
|
||
|
</table>
|
||
|
</div>
|
||
|
<!-- end header part -->
|
||
|
<!-- Generated by Doxygen 1.9.4 -->
|
||
|
<script type="text/javascript">
|
||
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||
|
var searchBox = new SearchBox("searchBox", "search",'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&dn=expat.txt MIT */
|
||
|
$(function() {
|
||
|
initMenu('',true,false,'search.php','Search');
|
||
|
$(document).ready(function() { init_search(); });
|
||
|
});
|
||
|
/* @license-end */
|
||
|
</script>
|
||
|
<div id="main-nav"></div>
|
||
|
<!-- 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 id="nav-path" class="navpath">
|
||
|
<ul>
|
||
|
<li class="navelem"><a class="el" href="dir_152a494004de7bf5f5699139fd63e08c.html">dnacalib</a></li><li class="navelem"><a class="el" href="dir_e342cf579e4a20e61ca12fdabd8b8b30.html">DNACalib</a></li><li class="navelem"><a class="el" href="dir_5f9eca1ce11313fc6eb46938d49ccb0b.html">include</a></li><li class="navelem"><a class="el" href="dir_5863af957a68c3845320844744c2532c.html">dna</a></li> </ul>
|
||
|
</div>
|
||
|
</div><!-- top -->
|
||
|
<div class="header">
|
||
|
<div class="headertitle"><div class="title">StreamReader.h</div></div>
|
||
|
</div><!--header-->
|
||
|
<div class="contents">
|
||
|
<a href="StreamReader_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright Epic Games, Inc. All Rights Reserved.</span></div>
|
||
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
|
||
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#pragma once</span></div>
|
||
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
|
||
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include "<a class="code" href="DataLayer_8h.html">dna/DataLayer.h</a>"</span></div>
|
||
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include "<a class="code" href="dna_2Defs_8h.html">dna/Defs.h</a>"</span></div>
|
||
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include "<a class="code" href="Reader_8h.html">dna/Reader.h</a>"</span></div>
|
||
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include "<a class="code" href="dna_2types_2Aliases_8h.html">dna/types/Aliases.h</a>"</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="keyword">namespace </span><a class="code hl_namespace" href="namespacedna.html">dna</a> {</div>
|
||
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
|
||
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="classdna_1_1StreamReader.html"> 12</a></span><span class="keyword">class </span><a class="code hl_define" href="dna_2Defs_8h.html#afd1577620b6c2292dfaf9889f59d9ca8">DNAAPI</a> <a class="code hl_class" href="classdna_1_1StreamReader.html">StreamReader</a> : <span class="keyword">public</span> <a class="code hl_class" href="classdna_1_1Reader.html">Reader</a> {</div>
|
||
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">public</span>:</div>
|
||
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="classdna_1_1StreamReader.html#a7e1e5a37ec4ba772aedf3aca7745f0a6"> 14</a></span> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code hl_struct" href="structsc_1_1StatusCode.html">sc::StatusCode</a> <a class="code hl_variable" href="classdna_1_1StreamReader.html#a7e1e5a37ec4ba772aedf3aca7745f0a6">SignatureMismatchError</a>;</div>
|
||
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="classdna_1_1StreamReader.html#a27a924f740fdab13ab0f813e0c028662"> 15</a></span> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code hl_struct" href="structsc_1_1StatusCode.html">sc::StatusCode</a> <a class="code hl_variable" href="classdna_1_1StreamReader.html#a27a924f740fdab13ab0f813e0c028662">VersionMismatchError</a>;</div>
|
||
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="classdna_1_1StreamReader.html#a068f4c84f7e6a5cafcca861aafe087b2"> 16</a></span> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code hl_struct" href="structsc_1_1StatusCode.html">sc::StatusCode</a> <a class="code hl_variable" href="classdna_1_1StreamReader.html#a068f4c84f7e6a5cafcca861aafe087b2">InvalidDataError</a>;</div>
|
||
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
|
||
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">public</span>:</div>
|
||
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="classdna_1_1StreamReader.html#ad8a9d117e532ebf9fbd5e970b15832d7"> 19</a></span> <a class="code hl_function" href="classdna_1_1StreamReader.html#ad8a9d117e532ebf9fbd5e970b15832d7">~StreamReader</a>() <span class="keyword">override</span>;</div>
|
||
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="classdna_1_1StreamReader.html#aa94b03ba813eac59b77b1365800ee8a4"> 23</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classdna_1_1StreamReader.html#aa94b03ba813eac59b77b1365800ee8a4">read</a>() = 0;</div>
|
||
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span>};</div>
|
||
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
|
||
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span>} <span class="comment">// namespace dna</span></div>
|
||
|
<div class="ttc" id="aDataLayer_8h_html"><div class="ttname"><a href="DataLayer_8h.html">DataLayer.h</a></div></div>
|
||
|
<div class="ttc" id="aReader_8h_html"><div class="ttname"><a href="Reader_8h.html">Reader.h</a></div></div>
|
||
|
<div class="ttc" id="aclassdna_1_1Reader_html"><div class="ttname"><a href="classdna_1_1Reader.html">dna::Reader</a></div><div class="ttdoc">The abstract Reader which its implementations are expected to inherit.</div><div class="ttdef"><b>Definition:</b> Reader.h:21</div></div>
|
||
|
<div class="ttc" id="aclassdna_1_1StreamReader_html"><div class="ttname"><a href="classdna_1_1StreamReader.html">dna::StreamReader</a></div><div class="ttdef"><b>Definition:</b> StreamReader.h:12</div></div>
|
||
|
<div class="ttc" id="aclassdna_1_1StreamReader_html_a068f4c84f7e6a5cafcca861aafe087b2"><div class="ttname"><a href="classdna_1_1StreamReader.html#a068f4c84f7e6a5cafcca861aafe087b2">dna::StreamReader::InvalidDataError</a></div><div class="ttdeci">static const sc::StatusCode InvalidDataError</div><div class="ttdef"><b>Definition:</b> StreamReader.h:16</div></div>
|
||
|
<div class="ttc" id="aclassdna_1_1StreamReader_html_a27a924f740fdab13ab0f813e0c028662"><div class="ttname"><a href="classdna_1_1StreamReader.html#a27a924f740fdab13ab0f813e0c028662">dna::StreamReader::VersionMismatchError</a></div><div class="ttdeci">static const sc::StatusCode VersionMismatchError</div><div class="ttdef"><b>Definition:</b> StreamReader.h:15</div></div>
|
||
|
<div class="ttc" id="aclassdna_1_1StreamReader_html_a7e1e5a37ec4ba772aedf3aca7745f0a6"><div class="ttname"><a href="classdna_1_1StreamReader.html#a7e1e5a37ec4ba772aedf3aca7745f0a6">dna::StreamReader::SignatureMismatchError</a></div><div class="ttdeci">static const sc::StatusCode SignatureMismatchError</div><div class="ttdef"><b>Definition:</b> StreamReader.h:14</div></div>
|
||
|
<div class="ttc" id="aclassdna_1_1StreamReader_html_aa94b03ba813eac59b77b1365800ee8a4"><div class="ttname"><a href="classdna_1_1StreamReader.html#aa94b03ba813eac59b77b1365800ee8a4">dna::StreamReader::read</a></div><div class="ttdeci">virtual void read()=0</div><div class="ttdoc">read data from stream into internal structures.</div></div>
|
||
|
<div class="ttc" id="aclassdna_1_1StreamReader_html_ad8a9d117e532ebf9fbd5e970b15832d7"><div class="ttname"><a href="classdna_1_1StreamReader.html#ad8a9d117e532ebf9fbd5e970b15832d7">dna::StreamReader::~StreamReader</a></div><div class="ttdeci">~StreamReader() override</div></div>
|
||
|
<div class="ttc" id="adna_2Defs_8h_html"><div class="ttname"><a href="dna_2Defs_8h.html">Defs.h</a></div></div>
|
||
|
<div class="ttc" id="adna_2Defs_8h_html_afd1577620b6c2292dfaf9889f59d9ca8"><div class="ttname"><a href="dna_2Defs_8h.html#afd1577620b6c2292dfaf9889f59d9ca8">DNAAPI</a></div><div class="ttdeci">#define DNAAPI</div><div class="ttdef"><b>Definition:</b> dna/Defs.h:26</div></div>
|
||
|
<div class="ttc" id="adna_2types_2Aliases_8h_html"><div class="ttname"><a href="dna_2types_2Aliases_8h.html">Aliases.h</a></div></div>
|
||
|
<div class="ttc" id="anamespacedna_html"><div class="ttname"><a href="namespacedna.html">dna</a></div><div class="ttdef"><b>Definition:</b> BinaryStreamReader.h:10</div></div>
|
||
|
<div class="ttc" id="astructsc_1_1StatusCode_html"><div class="ttname"><a href="structsc_1_1StatusCode.html">sc::StatusCode</a></div><div class="ttdef"><b>Definition:</b> StatusCode.h:11</div></div>
|
||
|
</div><!-- fragment --></div><!-- contents -->
|
||
|
<!-- start footer part -->
|
||
|
<hr class="footer"/><address class="footer"><small>
|
||
|
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.4
|
||
|
</small></address>
|
||
|
</body>
|
||
|
</html>
|