254 lines
13 KiB
HTML
254 lines
13 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: trio::Writable 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"> 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="namespacetrio.html">trio</a></li><li class="navelem"><a class="el" href="classtrio_1_1Writable.html">Writable</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="classtrio_1_1Writable-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">trio::Writable Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="Concepts_8h_source.html">Concepts.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for trio::Writable:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classtrio_1_1Writable__inherit__graph.png" border="0" usemap="#atrio_1_1Writable_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="atrio_1_1Writable_inherit__map" id="atrio_1_1Writable_inherit__map">
|
|
<area shape="rect" title=" " alt="" coords="370,5,467,112"/>
|
|
<area shape="rect" href="classtrio_1_1BoundedIOStream.html" title=" " alt="" coords="242,160,398,296"/>
|
|
<area shape="rect" href="classtrio_1_1anonymous__namespace_02MemoryStreamImpl_8cpp_03_1_1MemoryWriter.html" title=" " alt="" coords="423,160,612,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-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::Writable:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classtrio_1_1Writable__coll__graph.png" border="0" usemap="#atrio_1_1Writable_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="atrio_1_1Writable_coll__map" id="atrio_1_1Writable_coll__map">
|
|
<area shape="rect" title=" " alt="" coords="5,5,103,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:a463e8d3e652fc4c3ce971d3fc2eaec7e"><td class="memItemLeft" align="right" valign="top">virtual std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Writable.html#a463e8d3e652fc4c3ce971d3fc2eaec7e">write</a> (const char *source, std::size_t size)=0</td></tr>
|
|
<tr class="memdesc:a463e8d3e652fc4c3ce971d3fc2eaec7e"><td class="mdescLeft"> </td><td class="mdescRight">Writes bytes from the given buffer to the stream. <a href="classtrio_1_1Writable.html#a463e8d3e652fc4c3ce971d3fc2eaec7e">More...</a><br /></td></tr>
|
|
<tr class="separator:a463e8d3e652fc4c3ce971d3fc2eaec7e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7c23fed723a8afefd8ecfd78a48d18dc"><td class="memItemLeft" align="right" valign="top">virtual std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Writable.html#a7c23fed723a8afefd8ecfd78a48d18dc">write</a> (<a class="el" href="classtrio_1_1Readable.html">Readable</a> *source, std::size_t size)=0</td></tr>
|
|
<tr class="memdesc:a7c23fed723a8afefd8ecfd78a48d18dc"><td class="mdescLeft"> </td><td class="mdescRight">Writes bytes from the given stream to this stream. <a href="classtrio_1_1Writable.html#a7c23fed723a8afefd8ecfd78a48d18dc">More...</a><br /></td></tr>
|
|
<tr class="separator:a7c23fed723a8afefd8ecfd78a48d18dc"><td class="memSeparator" colspan="2"> </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:aadd7ce033795eb76f383ae341a17aa21"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Writable.html#aadd7ce033795eb76f383ae341a17aa21">~Writable</a> ()</td></tr>
|
|
<tr class="separator:aadd7ce033795eb76f383ae341a17aa21"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="aadd7ce033795eb76f383ae341a17aa21" name="aadd7ce033795eb76f383ae341a17aa21"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aadd7ce033795eb76f383ae341a17aa21">◆ </a></span>~Writable()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">trio::Writable::~Writable </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="a463e8d3e652fc4c3ce971d3fc2eaec7e" name="a463e8d3e652fc4c3ce971d3fc2eaec7e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a463e8d3e652fc4c3ce971d3fc2eaec7e">◆ </a></span>write() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual std::size_t trio::Writable::write </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>source</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::size_t </td>
|
|
<td class="paramname"><em>size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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>Writes bytes from the given buffer to the stream. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">source</td><td>Source buffer from which the data is going to be written to the stream. </td></tr>
|
|
<tr><td class="paramname">size</td><td>Number of bytes to write to the stream. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes written. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classtrio_1_1FileStreamImpl.html#a21553243d67bcf7b017a24d71820c9fb">trio::FileStreamImpl</a>, <a class="el" href="classtrio_1_1MemoryMappedFileStreamFallback.html#aedd4ee0667ca613bdf10dbcb9ebfdaa9">trio::MemoryMappedFileStreamFallback</a>, <a class="el" href="classtrio_1_1anonymous__namespace_02MemoryStreamImpl_8cpp_03_1_1MemoryWriter.html#ac5d39e5d900469d957664b53ddd6f1a1">trio::anonymous_namespace{MemoryStreamImpl.cpp}::MemoryWriter</a>, and <a class="el" href="classtrio_1_1MemoryStreamImpl.html#a6087ad6527a356c063d2b076bba1f6a7">trio::MemoryStreamImpl</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="classtrio_1_1FileStreamImpl.html#a6ea1c44150f144f5b632d4c32f62f08c">trio::FileStreamImpl::read()</a>, <a class="el" href="classtrio_1_1anonymous__namespace_02MemoryStreamImpl_8cpp_03_1_1MemoryReader.html#a4d05920810106ba6bc9e22ab23b7f939">trio::anonymous_namespace{MemoryStreamImpl.cpp}::MemoryReader::read()</a>, and <a class="el" href="classtrio_1_1MemoryStreamImpl.html#a1b9085ee7ff1210ca46142414cadbedc">trio::MemoryStreamImpl::read()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7c23fed723a8afefd8ecfd78a48d18dc" name="a7c23fed723a8afefd8ecfd78a48d18dc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7c23fed723a8afefd8ecfd78a48d18dc">◆ </a></span>write() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual std::size_t trio::Writable::write </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classtrio_1_1Readable.html">Readable</a> * </td>
|
|
<td class="paramname"><em>source</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::size_t </td>
|
|
<td class="paramname"><em>size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</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>Writes bytes from the given stream to this stream. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">source</td><td>Source stream from which the data is going to be written into this stream. </td></tr>
|
|
<tr><td class="paramname">size</td><td>Number of bytes to write to the stream. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes written. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classtrio_1_1FileStreamImpl.html#a876dfedc5ad235e338e53b6ab80d087d">trio::FileStreamImpl</a>, <a class="el" href="classtrio_1_1MemoryMappedFileStreamFallback.html#a9c2dfd3b3acaf8add9e07d16ec4f760f">trio::MemoryMappedFileStreamFallback</a>, <a class="el" href="classtrio_1_1anonymous__namespace_02MemoryStreamImpl_8cpp_03_1_1MemoryWriter.html#a9c1479f6c1a5db074cd8a280f03afab5">trio::anonymous_namespace{MemoryStreamImpl.cpp}::MemoryWriter</a>, and <a class="el" href="classtrio_1_1MemoryStreamImpl.html#ac83e4c44edeca8b430aec1fe554fc350">trio::MemoryStreamImpl</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 <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>
|