MacStd/classmacstd_1_1handle.html

839 lines
41 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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MacStd: macstd::handle&lt; T, INVAL &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">MacStd
</div>
<div id="projectbrief">OS X API using Standard C++</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.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>macstd</b></li><li class="navelem"><a class="el" href="classmacstd_1_1handle.html">handle</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-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classmacstd_1_1handle-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">macstd::handle&lt; T, INVAL &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Base abstract template class to support generic object handle keeping.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="common_8hpp_source.html">MacStd/common.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for macstd::handle&lt; T, INVAL &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classmacstd_1_1handle.png" usemap="#macstd::handle_3C_20T_2C_20INVAL_20_3E_map" alt=""/>
<map id="macstd::handle_3C_20T_2C_20INVAL_20_3E_map" name="macstd::handle_3C_20T_2C_20INVAL_20_3E_map">
<area href="classmacstd_1_1dplhandle.html" title="Base abstract template class to support object handle keeping for objects that support trivial handle..." alt="macstd::dplhandle&lt; T, INVAL &gt;" shape="rect" coords="0,56,189,80"/>
</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:a58be08519d6208ba2716dcd79d2f295e" id="r_a58be08519d6208ba2716dcd79d2f295e"><td class="memItemLeft" align="right" valign="top"><a id="a58be08519d6208ba2716dcd79d2f295e" name="a58be08519d6208ba2716dcd79d2f295e"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>handle</b> () noexcept</td></tr>
<tr class="memdesc:a58be08519d6208ba2716dcd79d2f295e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a new class instance with the object handle set to INVAL. <br /></td></tr>
<tr class="separator:a58be08519d6208ba2716dcd79d2f295e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5906d39969037175bf5b148935ab1d05" id="r_a5906d39969037175bf5b148935ab1d05"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5906d39969037175bf5b148935ab1d05">handle</a> (T h) noexcept</td></tr>
<tr class="memdesc:a5906d39969037175bf5b148935ab1d05"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a new class instance with an already available object handle. <br /></td></tr>
<tr class="separator:a5906d39969037175bf5b148935ab1d05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5e62370d363a2db991b691f5fa4d914" id="r_ae5e62370d363a2db991b691f5fa4d914"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae5e62370d363a2db991b691f5fa4d914">handle</a> (<a class="el" href="classmacstd_1_1handle.html">handle</a>&lt; T, INVAL &gt; &amp;&amp;h) noexcept</td></tr>
<tr class="memdesc:ae5e62370d363a2db991b691f5fa4d914"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move constructor. <br /></td></tr>
<tr class="separator:ae5e62370d363a2db991b691f5fa4d914"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0e382917ebdceabe1d1c80780cec8fd" id="r_ad0e382917ebdceabe1d1c80780cec8fd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmacstd_1_1handle.html">handle</a>&lt; T, INVAL &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad0e382917ebdceabe1d1c80780cec8fd">operator=</a> (T h) noexcept</td></tr>
<tr class="memdesc:ad0e382917ebdceabe1d1c80780cec8fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attaches already available object handle. <br /></td></tr>
<tr class="separator:ad0e382917ebdceabe1d1c80780cec8fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2027dc26b8d7dac3410dd9e302a01e31" id="r_a2027dc26b8d7dac3410dd9e302a01e31"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmacstd_1_1handle.html">handle</a>&lt; T, INVAL &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2027dc26b8d7dac3410dd9e302a01e31">operator=</a> (<a class="el" href="classmacstd_1_1handle.html">handle</a>&lt; T, INVAL &gt; &amp;&amp;h) noexcept</td></tr>
<tr class="memdesc:a2027dc26b8d7dac3410dd9e302a01e31"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move assignment. <br /></td></tr>
<tr class="separator:a2027dc26b8d7dac3410dd9e302a01e31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c6c0152d5cc967558720e9f8ce218df" id="r_a1c6c0152d5cc967558720e9f8ce218df"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1c6c0152d5cc967558720e9f8ce218df">operator T</a> () const</td></tr>
<tr class="memdesc:a1c6c0152d5cc967558720e9f8ce218df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Auto-typecasting operator. <br /></td></tr>
<tr class="separator:a1c6c0152d5cc967558720e9f8ce218df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab9ec0feedeb9d115f37d938e923d10c" id="r_aab9ec0feedeb9d115f37d938e923d10c"><td class="memItemLeft" align="right" valign="top">T *&amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aab9ec0feedeb9d115f37d938e923d10c">operator*</a> () const</td></tr>
<tr class="memdesc:aab9ec0feedeb9d115f37d938e923d10c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the object handle value when the object handle is a pointer to a value (class, struct, etc.). <br /></td></tr>
<tr class="separator:aab9ec0feedeb9d115f37d938e923d10c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8405a3ff7aefc002779984f856678960" id="r_a8405a3ff7aefc002779984f856678960"><td class="memItemLeft" align="right" valign="top">T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8405a3ff7aefc002779984f856678960">operator&amp;</a> ()</td></tr>
<tr class="memdesc:a8405a3ff7aefc002779984f856678960"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the object handle reference. <br /></td></tr>
<tr class="separator:a8405a3ff7aefc002779984f856678960"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff8db2489369bcdbb9ebf60ee7095878" id="r_aff8db2489369bcdbb9ebf60ee7095878"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aff8db2489369bcdbb9ebf60ee7095878">operator-&gt;</a> () const</td></tr>
<tr class="memdesc:aff8db2489369bcdbb9ebf60ee7095878"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides object handle member access when the object handle is a pointer to a class or struct. <br /></td></tr>
<tr class="separator:aff8db2489369bcdbb9ebf60ee7095878"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1d446bed338bb91b639fe2f34141b62" id="r_ac1d446bed338bb91b639fe2f34141b62"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac1d446bed338bb91b639fe2f34141b62">operator!</a> () const</td></tr>
<tr class="memdesc:ac1d446bed338bb91b639fe2f34141b62"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests if the object handle is invalid. <br /></td></tr>
<tr class="separator:ac1d446bed338bb91b639fe2f34141b62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae50ded4e3696cebbdb5145fa8f58ad23" id="r_ae50ded4e3696cebbdb5145fa8f58ad23"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae50ded4e3696cebbdb5145fa8f58ad23">operator&lt;</a> (T h) const</td></tr>
<tr class="memdesc:ae50ded4e3696cebbdb5145fa8f58ad23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is handle less than? <br /></td></tr>
<tr class="separator:ae50ded4e3696cebbdb5145fa8f58ad23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4eaa05a6124133c11663f1c6c2666f7b" id="r_a4eaa05a6124133c11663f1c6c2666f7b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4eaa05a6124133c11663f1c6c2666f7b">operator&lt;=</a> (T h) const</td></tr>
<tr class="memdesc:a4eaa05a6124133c11663f1c6c2666f7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is handle less than or equal to? <br /></td></tr>
<tr class="separator:a4eaa05a6124133c11663f1c6c2666f7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10b5fff674bc904f841925f54a98801e" id="r_a10b5fff674bc904f841925f54a98801e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a10b5fff674bc904f841925f54a98801e">operator&gt;=</a> (T h) const</td></tr>
<tr class="memdesc:a10b5fff674bc904f841925f54a98801e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is handle greater than or equal to? <br /></td></tr>
<tr class="separator:a10b5fff674bc904f841925f54a98801e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a862b5aec5f974071ddf14a2a7b6570d2" id="r_a862b5aec5f974071ddf14a2a7b6570d2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a862b5aec5f974071ddf14a2a7b6570d2">operator&gt;</a> (T h) const</td></tr>
<tr class="memdesc:a862b5aec5f974071ddf14a2a7b6570d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is handle greater than? <br /></td></tr>
<tr class="separator:a862b5aec5f974071ddf14a2a7b6570d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adcc4a33c5a33325aa3106d9eaab5384a" id="r_adcc4a33c5a33325aa3106d9eaab5384a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adcc4a33c5a33325aa3106d9eaab5384a">operator!=</a> (T h) const</td></tr>
<tr class="memdesc:adcc4a33c5a33325aa3106d9eaab5384a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is handle not equal to? <br /></td></tr>
<tr class="separator:adcc4a33c5a33325aa3106d9eaab5384a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a724b10f5424177670f04180e32b7f129" id="r_a724b10f5424177670f04180e32b7f129"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a724b10f5424177670f04180e32b7f129">operator==</a> (T h) const</td></tr>
<tr class="memdesc:a724b10f5424177670f04180e32b7f129"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is handle equal to? <br /></td></tr>
<tr class="separator:a724b10f5424177670f04180e32b7f129"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69d07a5c3334ce61998880b0d620c6fd" id="r_a69d07a5c3334ce61998880b0d620c6fd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a69d07a5c3334ce61998880b0d620c6fd">attach</a> (T h) noexcept</td></tr>
<tr class="memdesc:a69d07a5c3334ce61998880b0d620c6fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets a new object handle for the class. <br /></td></tr>
<tr class="separator:a69d07a5c3334ce61998880b0d620c6fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad17472a1418050b801ee80a32c49c325" id="r_ad17472a1418050b801ee80a32c49c325"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad17472a1418050b801ee80a32c49c325">detach</a> ()</td></tr>
<tr class="memdesc:ad17472a1418050b801ee80a32c49c325"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dismisses the object handle from this class. <br /></td></tr>
<tr class="separator:ad17472a1418050b801ee80a32c49c325"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbc07860aaf0eeeabe6e7e7474b6d176" id="r_afbc07860aaf0eeeabe6e7e7474b6d176"><td class="memItemLeft" align="right" valign="top"><a id="afbc07860aaf0eeeabe6e7e7474b6d176" name="afbc07860aaf0eeeabe6e7e7474b6d176"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>free</b> ()</td></tr>
<tr class="memdesc:afbc07860aaf0eeeabe6e7e7474b6d176"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys the object. <br /></td></tr>
<tr class="separator:afbc07860aaf0eeeabe6e7e7474b6d176"><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:a5e3365827f995ee2a580d2c669ddcafe" id="r_a5e3365827f995ee2a580d2c669ddcafe"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5e3365827f995ee2a580d2c669ddcafe">free_internal</a> () noexcept=0</td></tr>
<tr class="memdesc:a5e3365827f995ee2a580d2c669ddcafe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract member function that must be implemented by child classes to do the actual object destruction. <br /></td></tr>
<tr class="separator:a5e3365827f995ee2a580d2c669ddcafe"><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:ab65b198a6e06f14b29be176cdff7556e" id="r_ab65b198a6e06f14b29be176cdff7556e"><td class="memItemLeft" align="right" valign="top"><a id="ab65b198a6e06f14b29be176cdff7556e" name="ab65b198a6e06f14b29be176cdff7556e"></a>
T&#160;</td><td class="memItemRight" valign="bottom"><b>m_h</b></td></tr>
<tr class="memdesc:ab65b198a6e06f14b29be176cdff7556e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Object handle. <br /></td></tr>
<tr class="separator:ab65b198a6e06f14b29be176cdff7556e"><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, const T INVAL&gt;<br />
class macstd::handle&lt; T, INVAL &gt;</div><p>Base abstract template class to support generic object handle keeping. </p>
<p>It provides basic operators and methods common to all descendands of this class establishing a base to ease the replacement of native object handle type with classes in object-oriented approach. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5906d39969037175bf5b148935ab1d05" name="a5906d39969037175bf5b148935ab1d05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5906d39969037175bf5b148935ab1d05">&#9670;&#160;</a></span>handle() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , const T INVAL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmacstd_1_1handle.html">macstd::handle</a>&lt; T, INVAL &gt;::handle </td>
<td>(</td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>h</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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes a new class instance with an already available object handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>Initial object handle value </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae5e62370d363a2db991b691f5fa4d914" name="ae5e62370d363a2db991b691f5fa4d914"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5e62370d363a2db991b691f5fa4d914">&#9670;&#160;</a></span>handle() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , const T INVAL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmacstd_1_1handle.html">macstd::handle</a>&lt; T, INVAL &gt;::handle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmacstd_1_1handle.html">handle</a>&lt; T, INVAL &gt; &amp;&amp;</td> <td class="paramname"><span class="paramname"><em>h</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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">h</td><td>A rvalue reference of another object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a69d07a5c3334ce61998880b0d620c6fd" name="a69d07a5c3334ce61998880b0d620c6fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69d07a5c3334ce61998880b0d620c6fd">&#9670;&#160;</a></span>attach()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , const T INVAL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classmacstd_1_1handle.html">macstd::handle</a>&lt; T, INVAL &gt;::attach </td>
<td>(</td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>h</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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a new object handle for the class. </p>
<p>When the current object handle of the class is non-INVAL, the object is destroyed first.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>New object handle </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad17472a1418050b801ee80a32c49c325" name="ad17472a1418050b801ee80a32c49c325"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad17472a1418050b801ee80a32c49c325">&#9670;&#160;</a></span>detach()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , const T INVAL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T <a class="el" href="classmacstd_1_1handle.html">macstd::handle</a>&lt; T, INVAL &gt;::detach </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Dismisses the object handle from this class. </p>
<dl class="section return"><dt>Returns</dt><dd>Object handle </dd></dl>
</div>
</div>
<a id="a5e3365827f995ee2a580d2c669ddcafe" name="a5e3365827f995ee2a580d2c669ddcafe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e3365827f995ee2a580d2c669ddcafe">&#9670;&#160;</a></span>free_internal()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , const T INVAL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classmacstd_1_1handle.html">macstd::handle</a>&lt; T, INVAL &gt;::free_internal </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">protected</span><span class="mlabel">pure virtual</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Abstract member function that must be implemented by child classes to do the actual object destruction. </p>
<p>Implemented in <a class="el" href="classmacstd_1_1io__object.html#a897840743bbbdc938e757781fc453cb5">macstd::io_object&lt; T &gt;</a>.</p>
</div>
</div>
<a id="a1c6c0152d5cc967558720e9f8ce218df" name="a1c6c0152d5cc967558720e9f8ce218df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c6c0152d5cc967558720e9f8ce218df">&#9670;&#160;</a></span>operator T()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , const T INVAL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmacstd_1_1handle.html">macstd::handle</a>&lt; T, INVAL &gt;::operator T </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Auto-typecasting operator. </p>
<dl class="section return"><dt>Returns</dt><dd>Object handle </dd></dl>
</div>
</div>
<a id="ac1d446bed338bb91b639fe2f34141b62" name="ac1d446bed338bb91b639fe2f34141b62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1d446bed338bb91b639fe2f34141b62">&#9670;&#160;</a></span>operator!()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , const T INVAL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classmacstd_1_1handle.html">macstd::handle</a>&lt; T, INVAL &gt;::operator! </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tests if the object handle is invalid. </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>Non zero when object handle is invalid;</li>
<li>Zero otherwise.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Implementing <code>operator bool() const</code> would be correct C++ approach here. Unfortunately, it would produce ambiguities where <code>bool</code> and <code>T</code> are polymorphed. Use <code>!!</code> to test if the object handle is valid. </dd></dl>
</div>
</div>
<a id="adcc4a33c5a33325aa3106d9eaab5384a" name="adcc4a33c5a33325aa3106d9eaab5384a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adcc4a33c5a33325aa3106d9eaab5384a">&#9670;&#160;</a></span>operator!=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , const T INVAL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classmacstd_1_1handle.html">macstd::handle</a>&lt; T, INVAL &gt;<a class="el" href="#ac1d446bed338bb91b639fe2f34141b62">::operator!</a>= </td>
<td>(</td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>h</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Is handle not equal to? </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>Object handle to compare against </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>Non zero when object handle is not equal to h;</li>
<li>Zero otherwise. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a8405a3ff7aefc002779984f856678960" name="a8405a3ff7aefc002779984f856678960"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8405a3ff7aefc002779984f856678960">&#9670;&#160;</a></span>operator&amp;()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , const T INVAL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T * <a class="el" href="classmacstd_1_1handle.html">macstd::handle</a>&lt; T, INVAL &gt;::operator&amp; </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the object handle reference. </p>
<dl class="section return"><dt>Returns</dt><dd>Object handle reference </dd></dl>
</div>
</div>
<a id="aab9ec0feedeb9d115f37d938e923d10c" name="aab9ec0feedeb9d115f37d938e923d10c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab9ec0feedeb9d115f37d938e923d10c">&#9670;&#160;</a></span>operator*()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , const T INVAL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T *&amp; <a class="el" href="classmacstd_1_1handle.html">macstd::handle</a>&lt; T, INVAL &gt;::operator* </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the object handle value when the object handle is a pointer to a value (class, struct, etc.). </p>
<dl class="section return"><dt>Returns</dt><dd>Object handle value </dd></dl>
</div>
</div>
<a id="aff8db2489369bcdbb9ebf60ee7095878" name="aff8db2489369bcdbb9ebf60ee7095878"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff8db2489369bcdbb9ebf60ee7095878">&#9670;&#160;</a></span>operator-&gt;()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , const T INVAL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T <a class="el" href="classmacstd_1_1handle.html">macstd::handle</a>&lt; T, INVAL &gt;::operator-&gt; </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides object handle member access when the object handle is a pointer to a class or struct. </p>
<dl class="section return"><dt>Returns</dt><dd>Object handle </dd></dl>
</div>
</div>
<a id="ae50ded4e3696cebbdb5145fa8f58ad23" name="ae50ded4e3696cebbdb5145fa8f58ad23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae50ded4e3696cebbdb5145fa8f58ad23">&#9670;&#160;</a></span>operator&lt;()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , const T INVAL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classmacstd_1_1handle.html">macstd::handle</a>&lt; T, INVAL &gt;::operator&lt; </td>
<td>(</td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>h</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Is handle less than? </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>Object handle to compare against </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>Non zero when object handle is less than h;</li>
<li>Zero otherwise. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a4eaa05a6124133c11663f1c6c2666f7b" name="a4eaa05a6124133c11663f1c6c2666f7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4eaa05a6124133c11663f1c6c2666f7b">&#9670;&#160;</a></span>operator&lt;=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , const T INVAL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classmacstd_1_1handle.html">macstd::handle</a>&lt; T, INVAL &gt;::operator&lt;= </td>
<td>(</td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>h</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Is handle less than or equal to? </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>Object handle to compare against </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>Non zero when object handle is less than or equal to h;</li>
<li>Zero otherwise. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a2027dc26b8d7dac3410dd9e302a01e31" name="a2027dc26b8d7dac3410dd9e302a01e31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2027dc26b8d7dac3410dd9e302a01e31">&#9670;&#160;</a></span>operator=() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , const T INVAL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmacstd_1_1handle.html">handle</a>&lt; T, INVAL &gt; &amp; <a class="el" href="classmacstd_1_1handle.html">macstd::handle</a>&lt; T, INVAL &gt;::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmacstd_1_1handle.html">handle</a>&lt; T, INVAL &gt; &amp;&amp;</td> <td class="paramname"><span class="paramname"><em>h</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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move assignment. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">h</td><td>A rvalue reference of another object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad0e382917ebdceabe1d1c80780cec8fd" name="ad0e382917ebdceabe1d1c80780cec8fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0e382917ebdceabe1d1c80780cec8fd">&#9670;&#160;</a></span>operator=() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , const T INVAL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmacstd_1_1handle.html">handle</a>&lt; T, INVAL &gt; &amp; <a class="el" href="classmacstd_1_1handle.html">macstd::handle</a>&lt; T, INVAL &gt;::operator= </td>
<td>(</td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>h</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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Attaches already available object handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>Object handle value </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a724b10f5424177670f04180e32b7f129" name="a724b10f5424177670f04180e32b7f129"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a724b10f5424177670f04180e32b7f129">&#9670;&#160;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , const T INVAL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classmacstd_1_1handle.html">macstd::handle</a>&lt; T, INVAL &gt;::operator== </td>
<td>(</td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>h</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Is handle equal to? </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>Object handle to compare against </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>Non zero when object handle is equal to h;</li>
<li>Zero otherwise. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a862b5aec5f974071ddf14a2a7b6570d2" name="a862b5aec5f974071ddf14a2a7b6570d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a862b5aec5f974071ddf14a2a7b6570d2">&#9670;&#160;</a></span>operator&gt;()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , const T INVAL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classmacstd_1_1handle.html">macstd::handle</a>&lt; T, INVAL &gt;::operator&gt; </td>
<td>(</td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>h</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Is handle greater than? </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>Object handle to compare against </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>Non zero when object handle is greater than h;</li>
<li>Zero otherwise. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a10b5fff674bc904f841925f54a98801e" name="a10b5fff674bc904f841925f54a98801e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10b5fff674bc904f841925f54a98801e">&#9670;&#160;</a></span>operator&gt;=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , const T INVAL&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classmacstd_1_1handle.html">macstd::handle</a>&lt; T, INVAL &gt;::operator&gt;= </td>
<td>(</td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>h</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Is handle greater than or equal to? </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>Object handle to compare against </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>Non zero when object handle is greater than or equal to h;</li>
<li>Zero otherwise. </li>
</ul>
</dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/MacStd/<a class="el" href="common_8hpp_source.html">common.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Oct 1 2024 11:48:46 for MacStd by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>