Metahuman_DNA_Calibration/docs/doxygen/build/html/classtrio_1_1Seekable.html

225 lines
11 KiB
HTML
Raw Normal View History

2022-11-28 19:21:26 +08:00
<!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: trio::Seekable 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="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">&#160;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&amp;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&amp;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="namespacetrio.html">trio</a></li><li class="navelem"><a class="el" href="classtrio_1_1Seekable.html">Seekable</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classtrio_1_1Seekable-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">trio::Seekable Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="Concepts_8h_source.html">Concepts.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for trio::Seekable:</div>
<div class="dyncontent">
<div class="center"><img src="classtrio_1_1Seekable__inherit__graph.png" border="0" usemap="#atrio_1_1Seekable_inherit__map" alt="Inheritance graph"/></div>
<map name="atrio_1_1Seekable_inherit__map" id="atrio_1_1Seekable_inherit__map">
<area shape="rect" title=" " alt="" coords="269,5,371,112"/>
<area shape="rect" href="classtrio_1_1BoundedIOStream.html" title=" " alt="" coords="242,160,398,296"/>
<area shape="rect" href="classtrio_1_1FileStream.html" title="Standard file stream." alt="" coords="55,351,169,531"/>
<area shape="rect" href="classtrio_1_1MemoryMappedFileStream.html" title="Memory mapped file stream." alt="" coords="217,351,423,531"/>
<area shape="rect" href="classtrio_1_1MemoryStream.html" title="In&#45;memory stream." alt="" coords="465,344,604,539"/>
<area shape="rect" href="classtrio_1_1FileStreamImpl.html" title=" " alt="" coords="5,609,168,921"/>
<area shape="rect" href="classtrio_1_1MemoryMappedFileStreamFallback.html" title=" " alt="" coords="193,587,447,943"/>
<area shape="rect" href="classtrio_1_1MemoryStreamImpl.html" title=" " alt="" coords="472,631,635,899"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for trio::Seekable:</div>
<div class="dyncontent">
<div class="center"><img src="classtrio_1_1Seekable__coll__graph.png" border="0" usemap="#atrio_1_1Seekable_coll__map" alt="Collaboration graph"/></div>
<map name="atrio_1_1Seekable_coll__map" id="atrio_1_1Seekable_coll__map">
<area shape="rect" title=" " alt="" coords="5,5,108,112"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af5071bbc6e4760fdfb3d5c0d83117b85"><td class="memItemLeft" align="right" valign="top">virtual std::uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Seekable.html#af5071bbc6e4760fdfb3d5c0d83117b85">tell</a> ()=0</td></tr>
<tr class="memdesc:af5071bbc6e4760fdfb3d5c0d83117b85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current position in the stream. <a href="classtrio_1_1Seekable.html#af5071bbc6e4760fdfb3d5c0d83117b85">More...</a><br /></td></tr>
<tr class="separator:af5071bbc6e4760fdfb3d5c0d83117b85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea11c922f49ddf61a0f30f7ad41dde2c"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Seekable.html#aea11c922f49ddf61a0f30f7ad41dde2c">seek</a> (std::uint64_t position)=0</td></tr>
<tr class="memdesc:aea11c922f49ddf61a0f30f7ad41dde2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the current position in the stream. <a href="classtrio_1_1Seekable.html#aea11c922f49ddf61a0f30f7ad41dde2c">More...</a><br /></td></tr>
<tr class="separator:aea11c922f49ddf61a0f30f7ad41dde2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:abbd824465ebc3080b3c1d84f3266bb2d"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Seekable.html#abbd824465ebc3080b3c1d84f3266bb2d">~Seekable</a> ()</td></tr>
<tr class="separator:abbd824465ebc3080b3c1d84f3266bb2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="abbd824465ebc3080b3c1d84f3266bb2d" name="abbd824465ebc3080b3c1d84f3266bb2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbd824465ebc3080b3c1d84f3266bb2d">&#9670;&nbsp;</a></span>~Seekable()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">trio::Seekable::~Seekable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aea11c922f49ddf61a0f30f7ad41dde2c" name="aea11c922f49ddf61a0f30f7ad41dde2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea11c922f49ddf61a0f30f7ad41dde2c">&#9670;&nbsp;</a></span>seek()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void trio::Seekable::seek </td>
<td>(</td>
<td class="paramtype">std::uint64_t&#160;</td>
<td class="paramname"><em>position</em></td><td>)</td>
<td></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>Set the current position in the stream. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>Position in the stream relative to it's start, with 0 denoting the start position. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classtrio_1_1FileStreamImpl.html#a6f2a2ac467cec1b636300d6ed9ab9f48">trio::FileStreamImpl</a>, <a class="el" href="classtrio_1_1MemoryMappedFileStreamFallback.html#a847834bf4e47c8a737a5f64315d4365a">trio::MemoryMappedFileStreamFallback</a>, and <a class="el" href="classtrio_1_1MemoryStreamImpl.html#a0a02d6bcef1fde8ec6631c0e052f2172">trio::MemoryStreamImpl</a>.</p>
<p class="reference">Referenced by <a class="el" href="classdna_1_1FilteredInputArchive.html#a2f628b27204bf40c31713e8cfea9883d">dna::FilteredInputArchive::processSubset()</a>.</p>
</div>
</div>
<a id="af5071bbc6e4760fdfb3d5c0d83117b85" name="af5071bbc6e4760fdfb3d5c0d83117b85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5071bbc6e4760fdfb3d5c0d83117b85">&#9670;&nbsp;</a></span>tell()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::uint64_t trio::Seekable::tell </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>Get the current position in the stream. </p>
<dl class="section return"><dt>Returns</dt><dd>Position in the stream relative to it's start, with 0 denoting the start position. </dd></dl>
<p>Implemented in <a class="el" href="classtrio_1_1FileStreamImpl.html#a35066ab7b50de21eeca6a592c11a4cd1">trio::FileStreamImpl</a>, <a class="el" href="classtrio_1_1MemoryMappedFileStreamFallback.html#a0898cbc7aaeedf49dff8feae7f9e1e33">trio::MemoryMappedFileStreamFallback</a>, and <a class="el" href="classtrio_1_1MemoryStreamImpl.html#a1b8fb1f80d37a444261fb574701bb193">trio::MemoryStreamImpl</a>.</p>
<p class="reference">Referenced by <a class="el" href="classdna_1_1FilteredInputArchive.html#a2f628b27204bf40c31713e8cfea9883d">dna::FilteredInputArchive::processSubset()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Concepts_8h_source.html">Concepts.h</a></li>
<li><a class="el" href="Concepts_8cpp.html">Concepts.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>