Metahuman_DNA_Calibration/docs/doxygen/build/html/classtrio_1_1StreamScope.html

327 lines
18 KiB
HTML
Raw Permalink 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::StreamScope 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_1StreamScope.html">StreamScope</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classtrio_1_1StreamScope-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">trio::StreamScope Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="StreamScope_8h_source.html">StreamScope.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for trio::StreamScope:</div>
<div class="dyncontent">
<div class="center"><img src="classtrio_1_1StreamScope__coll__graph.png" border="0" usemap="#atrio_1_1StreamScope_coll__map" alt="Collaboration graph"/></div>
<map name="atrio_1_1StreamScope_coll__map" id="atrio_1_1StreamScope_coll__map">
<area shape="rect" title=" " alt="" coords="57,287,186,437"/>
<area shape="rect" href="classtrio_1_1Controllable.html" title=" " alt="" coords="63,147,180,224"/>
<area shape="rect" href="classtrio_1_1Openable.html" title=" " alt="" coords="5,5,109,97"/>
<area shape="rect" href="classtrio_1_1Closeable.html" title=" " alt="" coords="133,5,240,97"/>
</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:ad831d5755dc77592ccbf39dcafd67335"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1StreamScope.html#ad831d5755dc77592ccbf39dcafd67335">StreamScope</a> (<a class="el" href="classtrio_1_1Controllable.html">Controllable</a> *stream_)</td></tr>
<tr class="separator:ad831d5755dc77592ccbf39dcafd67335"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82073a5f161d716f4ea2f23acdea0f4b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1StreamScope.html#a82073a5f161d716f4ea2f23acdea0f4b">~StreamScope</a> ()</td></tr>
<tr class="separator:a82073a5f161d716f4ea2f23acdea0f4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06f1f638090897d7b01f351d1c0e21c3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1StreamScope.html#a06f1f638090897d7b01f351d1c0e21c3">StreamScope</a> (const <a class="el" href="classtrio_1_1StreamScope.html">StreamScope</a> &amp;)=delete</td></tr>
<tr class="separator:a06f1f638090897d7b01f351d1c0e21c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd13ea6dfdb735bf6b39892131e9c878"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classtrio_1_1StreamScope.html">StreamScope</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1StreamScope.html#abd13ea6dfdb735bf6b39892131e9c878">operator=</a> (const <a class="el" href="classtrio_1_1StreamScope.html">StreamScope</a> &amp;)=delete</td></tr>
<tr class="separator:abd13ea6dfdb735bf6b39892131e9c878"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d32f3b96309852c536034f2e4723c4e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1StreamScope.html#a4d32f3b96309852c536034f2e4723c4e">StreamScope</a> (<a class="el" href="classtrio_1_1StreamScope.html">StreamScope</a> &amp;&amp;rhs) noexcept</td></tr>
<tr class="separator:a4d32f3b96309852c536034f2e4723c4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae4acf0025772284b5f564966e8bac67"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classtrio_1_1StreamScope.html">StreamScope</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1StreamScope.html#aae4acf0025772284b5f564966e8bac67">operator=</a> (<a class="el" href="classtrio_1_1StreamScope.html">StreamScope</a> &amp;&amp;rhs) noexcept</td></tr>
<tr class="separator:aae4acf0025772284b5f564966e8bac67"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a743c536e777257c5ba3bb3807ffc8d9d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classtrio_1_1Controllable.html">Controllable</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1StreamScope.html#a743c536e777257c5ba3bb3807ffc8d9d">stream</a></td></tr>
<tr class="separator:a743c536e777257c5ba3bb3807ffc8d9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad831d5755dc77592ccbf39dcafd67335" name="ad831d5755dc77592ccbf39dcafd67335"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad831d5755dc77592ccbf39dcafd67335">&#9670;&nbsp;</a></span>StreamScope() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">trio::StreamScope::StreamScope </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classtrio_1_1Controllable.html">Controllable</a> *&#160;</td>
<td class="paramname"><em>stream_</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<div class="fragment"><div class="line"><span class="lineno"> 13</span> : <a class="code hl_variable" href="classtrio_1_1StreamScope.html#a743c536e777257c5ba3bb3807ffc8d9d">stream</a>{stream_} {</div>
<div class="line"><span class="lineno"> 14</span> <a class="code hl_variable" href="classtrio_1_1StreamScope.html#a743c536e777257c5ba3bb3807ffc8d9d">stream</a>-&gt;<a class="code hl_function" href="classtrio_1_1Openable.html#addfdc5360983a446fe200410a3eaef8f">open</a>();</div>
<div class="line"><span class="lineno"> 15</span> }</div>
<div class="ttc" id="aclasstrio_1_1Openable_html_addfdc5360983a446fe200410a3eaef8f"><div class="ttname"><a href="classtrio_1_1Openable.html#addfdc5360983a446fe200410a3eaef8f">trio::Openable::open</a></div><div class="ttdeci">virtual void open()=0</div><div class="ttdoc">Open access to the stream.</div></div>
<div class="ttc" id="aclasstrio_1_1StreamScope_html_a743c536e777257c5ba3bb3807ffc8d9d"><div class="ttname"><a href="classtrio_1_1StreamScope.html#a743c536e777257c5ba3bb3807ffc8d9d">trio::StreamScope::stream</a></div><div class="ttdeci">Controllable * stream</div><div class="ttdef"><b>Definition:</b> StreamScope.h:36</div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="classtrio_1_1Openable.html#addfdc5360983a446fe200410a3eaef8f">trio::Openable::open()</a>, and <a class="el" href="classtrio_1_1StreamScope.html#a743c536e777257c5ba3bb3807ffc8d9d">stream</a>.</p>
</div>
</div>
<a id="a82073a5f161d716f4ea2f23acdea0f4b" name="a82073a5f161d716f4ea2f23acdea0f4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82073a5f161d716f4ea2f23acdea0f4b">&#9670;&nbsp;</a></span>~StreamScope()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">trio::StreamScope::~StreamScope </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<div class="fragment"><div class="line"><span class="lineno"> 17</span> {</div>
<div class="line"><span class="lineno"> 18</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="classtrio_1_1StreamScope.html#a743c536e777257c5ba3bb3807ffc8d9d">stream</a> != <span class="keyword">nullptr</span>) {</div>
<div class="line"><span class="lineno"> 19</span> <a class="code hl_variable" href="classtrio_1_1StreamScope.html#a743c536e777257c5ba3bb3807ffc8d9d">stream</a>-&gt;<a class="code hl_function" href="classtrio_1_1Closeable.html#ac2e99d3bd99a39cf528ba29b1ba0baf1">close</a>();</div>
<div class="line"><span class="lineno"> 20</span> }</div>
<div class="line"><span class="lineno"> 21</span> }</div>
<div class="ttc" id="aclasstrio_1_1Closeable_html_ac2e99d3bd99a39cf528ba29b1ba0baf1"><div class="ttname"><a href="classtrio_1_1Closeable.html#ac2e99d3bd99a39cf528ba29b1ba0baf1">trio::Closeable::close</a></div><div class="ttdeci">virtual void close()=0</div><div class="ttdoc">Close access to the stream.</div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="classtrio_1_1Closeable.html#ac2e99d3bd99a39cf528ba29b1ba0baf1">trio::Closeable::close()</a>, and <a class="el" href="classtrio_1_1StreamScope.html#a743c536e777257c5ba3bb3807ffc8d9d">stream</a>.</p>
</div>
</div>
<a id="a06f1f638090897d7b01f351d1c0e21c3" name="a06f1f638090897d7b01f351d1c0e21c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06f1f638090897d7b01f351d1c0e21c3">&#9670;&nbsp;</a></span>StreamScope() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">trio::StreamScope::StreamScope </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classtrio_1_1StreamScope.html">StreamScope</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a4d32f3b96309852c536034f2e4723c4e" name="a4d32f3b96309852c536034f2e4723c4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d32f3b96309852c536034f2e4723c4e">&#9670;&nbsp;</a></span>StreamScope() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">trio::StreamScope::StreamScope </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classtrio_1_1StreamScope.html">StreamScope</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<div class="fragment"><div class="line"><span class="lineno"> 26</span> : <a class="code hl_variable" href="classtrio_1_1StreamScope.html#a743c536e777257c5ba3bb3807ffc8d9d">stream</a>{<span class="keyword">nullptr</span>} {</div>
<div class="line"><span class="lineno"> 27</span> std::swap(<a class="code hl_variable" href="classtrio_1_1StreamScope.html#a743c536e777257c5ba3bb3807ffc8d9d">stream</a>, rhs.stream);</div>
<div class="line"><span class="lineno"> 28</span> }</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abd13ea6dfdb735bf6b39892131e9c878" name="abd13ea6dfdb735bf6b39892131e9c878"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd13ea6dfdb735bf6b39892131e9c878">&#9670;&nbsp;</a></span>operator=() <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"><a class="el" href="classtrio_1_1StreamScope.html">StreamScope</a> &amp; trio::StreamScope::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classtrio_1_1StreamScope.html">StreamScope</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aae4acf0025772284b5f564966e8bac67" name="aae4acf0025772284b5f564966e8bac67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae4acf0025772284b5f564966e8bac67">&#9670;&nbsp;</a></span>operator=() <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"><a class="el" href="classtrio_1_1StreamScope.html">StreamScope</a> &amp; trio::StreamScope::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classtrio_1_1StreamScope.html">StreamScope</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<div class="fragment"><div class="line"><span class="lineno"> 30</span> {</div>
<div class="line"><span class="lineno"> 31</span> std::swap(<a class="code hl_variable" href="classtrio_1_1StreamScope.html#a743c536e777257c5ba3bb3807ffc8d9d">stream</a>, rhs.stream);</div>
<div class="line"><span class="lineno"> 32</span> <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><span class="lineno"> 33</span> }</div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="classtrio_1_1StreamScope.html#a743c536e777257c5ba3bb3807ffc8d9d">stream</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a743c536e777257c5ba3bb3807ffc8d9d" name="a743c536e777257c5ba3bb3807ffc8d9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a743c536e777257c5ba3bb3807ffc8d9d">&#9670;&nbsp;</a></span>stream</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classtrio_1_1Controllable.html">Controllable</a>* trio::StreamScope::stream</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">Referenced by <a class="el" href="classtrio_1_1StreamScope.html#aae4acf0025772284b5f564966e8bac67">operator=()</a>, <a class="el" href="classtrio_1_1StreamScope.html#ad831d5755dc77592ccbf39dcafd67335">StreamScope()</a>, and <a class="el" href="classtrio_1_1StreamScope.html#a82073a5f161d716f4ea2f23acdea0f4b">~StreamScope()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="StreamScope_8h_source.html">StreamScope.h</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>