stdex/classstdex_1_1basic__sys__object.html

196 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" lang="en-US">
<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.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>stdex: stdex::basic_sys_object&lt; T, TR &gt; Class 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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">stdex
</div>
<div id="projectbrief">Additional custom or not Standard C++ covered algorithms</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.11.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>stdex</b></li><li class="navelem"><a class="el" href="classstdex_1_1basic__sys__object.html">basic_sys_object</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classstdex_1_1basic__sys__object-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">stdex::basic_sys_object&lt; T, TR &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Operating system object base class.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="system_8hpp_source.html">stdex/system.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for stdex::basic_sys_object&lt; T, TR &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classstdex_1_1basic__sys__object.png" usemap="#stdex::basic_5Fsys_5Fobject_3C_20T_2C_20TR_20_3E_map" alt=""/>
<map id="stdex::basic_5Fsys_5Fobject_3C_20T_2C_20TR_20_3E_map" name="stdex::basic_5Fsys_5Fobject_3C_20T_2C_20TR_20_3E_map">
<area href="classstdex_1_1stream_1_1basic__sys.html" title="OS data stream (file, pipe, socket...)" alt="stdex::stream::basic_sys" shape="rect" coords="0,56,199,80"/>
<area href="classstdex_1_1stream_1_1file.html" title="File-system file." alt="stdex::stream::file" shape="rect" coords="0,112,199,136"/>
</map>
</div></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:a75094a060f53be5b399922bfd5171f43" id="r_a75094a060f53be5b399922bfd5171f43"><td class="memItemLeft" align="right" valign="top"><a id="a75094a060f53be5b399922bfd5171f43" name="a75094a060f53be5b399922bfd5171f43"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>basic_sys_object</b> (T h=TR::invalid_handle)</td></tr>
<tr class="separator:a75094a060f53be5b399922bfd5171f43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a159ba70af60396569fb2837128eeab98" id="r_a159ba70af60396569fb2837128eeab98"><td class="memItemLeft" align="right" valign="top"><a id="a159ba70af60396569fb2837128eeab98" name="a159ba70af60396569fb2837128eeab98"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>basic_sys_object</b> (const <a class="el" href="classstdex_1_1basic__sys__object.html">basic_sys_object</a>&lt; T, TR &gt; &amp;other)</td></tr>
<tr class="separator:a159ba70af60396569fb2837128eeab98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d2e0813abb0360c436754b9d2d4e4ea" id="r_a4d2e0813abb0360c436754b9d2d4e4ea"><td class="memItemLeft" align="right" valign="top"><a id="a4d2e0813abb0360c436754b9d2d4e4ea" name="a4d2e0813abb0360c436754b9d2d4e4ea"></a>
<a class="el" href="classstdex_1_1basic__sys__object.html">basic_sys_object</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classstdex_1_1basic__sys__object.html">basic_sys_object</a>&lt; T, TR &gt; &amp;other)</td></tr>
<tr class="separator:a4d2e0813abb0360c436754b9d2d4e4ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc7871f1a0ee93f76f8936a842653635" id="r_adc7871f1a0ee93f76f8936a842653635"><td class="memItemLeft" align="right" valign="top"><a id="adc7871f1a0ee93f76f8936a842653635" name="adc7871f1a0ee93f76f8936a842653635"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>basic_sys_object</b> (<a class="el" href="classstdex_1_1basic__sys__object.html">basic_sys_object</a>&lt; T, TR &gt; &amp;&amp;other) noexcept</td></tr>
<tr class="separator:adc7871f1a0ee93f76f8936a842653635"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e4b0c70abe440d0a1f11a6b6d5a61ac" id="r_a5e4b0c70abe440d0a1f11a6b6d5a61ac"><td class="memItemLeft" align="right" valign="top"><a id="a5e4b0c70abe440d0a1f11a6b6d5a61ac" name="a5e4b0c70abe440d0a1f11a6b6d5a61ac"></a>
<a class="el" href="classstdex_1_1basic__sys__object.html">basic_sys_object</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classstdex_1_1basic__sys__object.html">basic_sys_object</a>&lt; T, TR &gt; &amp;&amp;other) noexcept</td></tr>
<tr class="separator:a5e4b0c70abe440d0a1f11a6b6d5a61ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09e44076695b4134e877c3e6f1f29844" id="r_a09e44076695b4134e877c3e6f1f29844"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a09e44076695b4134e877c3e6f1f29844">close</a> ()</td></tr>
<tr class="memdesc:a09e44076695b4134e877c3e6f1f29844"><td class="mdescLeft">&#160;</td><td class="mdescRight">Closes object. <br /></td></tr>
<tr class="separator:a09e44076695b4134e877c3e6f1f29844"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88e048c0a2cc8221818e8761f7905018" id="r_a88e048c0a2cc8221818e8761f7905018"><td class="memItemLeft" align="right" valign="top"><a id="a88e048c0a2cc8221818e8761f7905018" name="a88e048c0a2cc8221818e8761f7905018"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>operator bool</b> () const noexcept</td></tr>
<tr class="memdesc:a88e048c0a2cc8221818e8761f7905018"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if object has a valid handle. <br /></td></tr>
<tr class="separator:a88e048c0a2cc8221818e8761f7905018"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc3efba439fefd090e2926be86236453" id="r_acc3efba439fefd090e2926be86236453"><td class="memItemLeft" align="right" valign="top"><a id="acc3efba439fefd090e2926be86236453" name="acc3efba439fefd090e2926be86236453"></a>
T&#160;</td><td class="memItemRight" valign="bottom"><b>get</b> () const noexcept</td></tr>
<tr class="memdesc:acc3efba439fefd090e2926be86236453"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns object handle. <br /></td></tr>
<tr class="separator:acc3efba439fefd090e2926be86236453"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:adb819c5c60f3ab8d0dc90e8f97508066" id="r_adb819c5c60f3ab8d0dc90e8f97508066"><td class="memItemLeft" align="right" valign="top"><a id="adb819c5c60f3ab8d0dc90e8f97508066" name="adb819c5c60f3ab8d0dc90e8f97508066"></a>
T&#160;</td><td class="memItemRight" valign="bottom"><b>m_h</b></td></tr>
<tr class="separator:adb819c5c60f3ab8d0dc90e8f97508066"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class T = sys_handle, class TR = sys_object_traits&gt;<br />
class stdex::basic_sys_object&lt; T, TR &gt;</div><p>Operating system object base class. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a09e44076695b4134e877c3e6f1f29844" name="a09e44076695b4134e877c3e6f1f29844"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09e44076695b4134e877c3e6f1f29844">&#9670;&#160;</a></span>close()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T = sys_handle, class TR = sys_object_traits&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classstdex_1_1basic__sys__object.html">stdex::basic_sys_object</a>&lt; T, TR &gt;::close </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes object. </p>
<p>Reimplemented in <a class="el" href="classstdex_1_1stream_1_1basic__sys.html#aee56fbeb8b576a4337cb205ae865fafc">stdex::stream::basic_sys</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/stdex/<a class="el" href="system_8hpp_source.html">system.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon May 27 2024 10:18:28 for stdex by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.11.0
</small></address>
</div><!-- doc-content -->
</body>
</html>