XQuilla/docs/simple-api/classRefCountPointer.html
2020-02-17 22:24:47 +01:00

381 lines
18 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XQilla Simple API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<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="classRefCountPointer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">RefCountPointer&lt; T &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Super class of all the reference counted wrappers for Items.
<a href="classRefCountPointer.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ReferenceCounted_8hpp_source.html">ReferenceCounted.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for RefCountPointer&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classRefCountPointer__inherit__graph.png" border="0" usemap="#RefCountPointer_3_01T_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="RefCountPointer_3_01T_01_4_inherit__map" id="RefCountPointer_3_01T_01_4_inherit__map">
<area shape="rect" id="node2" href="classRefCountPointer.html" title="RefCountPointer\&lt; const\l Item \&gt;" alt="" coords="5,97,168,138"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a19e599ede99710afeca89ba65cdcb2a1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#a19e599ede99710afeca89ba65cdcb2a1">RefCountPointer</a> (T *p=0)</td></tr>
<tr class="separator:a19e599ede99710afeca89ba65cdcb2a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afcdde22eed8a271196e22f1ef5e6b48b"><td class="memTemplParams" colspan="2">template&lt;class T2 &gt; </td></tr>
<tr class="memitem:afcdde22eed8a271196e22f1ef5e6b48b"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#afcdde22eed8a271196e22f1ef5e6b48b">RefCountPointer</a> (const <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T2 &gt; &amp;o)</td></tr>
<tr class="separator:afcdde22eed8a271196e22f1ef5e6b48b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adeb7f9624e9181b2b04950c38d4a8fce"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#adeb7f9624e9181b2b04950c38d4a8fce">RefCountPointer</a> (const <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt; &amp;o)</td></tr>
<tr class="separator:adeb7f9624e9181b2b04950c38d4a8fce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaed4cb34420ba9a5190e142cdb3c786d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRefCountPointer.html">RefCountPointer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#aaed4cb34420ba9a5190e142cdb3c786d">operator=</a> (const <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt; &amp;o)</td></tr>
<tr class="separator:aaed4cb34420ba9a5190e142cdb3c786d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15aac5f85305a123c357bbddf5030ef3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#a15aac5f85305a123c357bbddf5030ef3">~RefCountPointer</a> ()</td></tr>
<tr class="separator:a15aac5f85305a123c357bbddf5030ef3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19c9fb1b8719f5b010c0943e3594296a"><td class="memItemLeft" align="right" valign="top">T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#a19c9fb1b8719f5b010c0943e3594296a">operator-&gt;</a> () const </td></tr>
<tr class="separator:a19c9fb1b8719f5b010c0943e3594296a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6522f582ede5cc4a36fc990bf5165f7d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#a6522f582ede5cc4a36fc990bf5165f7d">operator T *</a> () const </td></tr>
<tr class="separator:a6522f582ede5cc4a36fc990bf5165f7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad04c84082534aa246546bd0c3355848"><td class="memItemLeft" align="right" valign="top">T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#aad04c84082534aa246546bd0c3355848">get</a> () const </td></tr>
<tr class="separator:aad04c84082534aa246546bd0c3355848"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62f15012bafcbe02f0dcdbd2c0a749ee"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#a62f15012bafcbe02f0dcdbd2c0a749ee">isNull</a> () const </td></tr>
<tr class="separator:a62f15012bafcbe02f0dcdbd2c0a749ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1de8e3bd6a0af6661047049983243e1c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#a1de8e3bd6a0af6661047049983243e1c">notNull</a> () const </td></tr>
<tr class="separator:a1de8e3bd6a0af6661047049983243e1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:abdad2242b59d285fe75208c5fed5a90a"><td class="memItemLeft" align="right" valign="top">T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#abdad2242b59d285fe75208c5fed5a90a">_p</a></td></tr>
<tr class="separator:abdad2242b59d285fe75208c5fed5a90a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class T&gt;<br/>
class RefCountPointer&lt; T &gt;</h3>
<p>Super class of all the reference counted wrappers for Items. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a19e599ede99710afeca89ba65cdcb2a1"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt;::<a class="el" href="classRefCountPointer.html">RefCountPointer</a> </td>
<td>(</td>
<td class="paramtype">T *&#160;</td>
<td class="paramname"><em>p</em> = <code>0</code></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>
</div>
<a class="anchor" id="afcdde22eed8a271196e22f1ef5e6b48b"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<div class="memtemplate">
template&lt;class T2 &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt;::<a class="el" href="classRefCountPointer.html">RefCountPointer</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T2 &gt; &amp;&#160;</td>
<td class="paramname"><em>o</em></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>
</div>
<a class="anchor" id="adeb7f9624e9181b2b04950c38d4a8fce"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt;::<a class="el" href="classRefCountPointer.html">RefCountPointer</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>o</em></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>
</div>
<a class="anchor" id="a15aac5f85305a123c357bbddf5030ef3"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt;::~<a class="el" href="classRefCountPointer.html">RefCountPointer</a> </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>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aad04c84082534aa246546bd0c3355848"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt;::get </td>
<td>(</td>
<td class="paramname"></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">
</div>
</div>
<a class="anchor" id="a62f15012bafcbe02f0dcdbd2c0a749ee"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt;::isNull </td>
<td>(</td>
<td class="paramname"></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">
</div>
</div>
<a class="anchor" id="a1de8e3bd6a0af6661047049983243e1c"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt;::notNull </td>
<td>(</td>
<td class="paramname"></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>Referenced by <a class="el" href="classEventGenerator.html#af5706f4d964a19492fed64cb14a9eb73">EventGenerator::generateAndTailCall()</a>.</p>
</div>
</div>
<a class="anchor" id="a6522f582ede5cc4a36fc990bf5165f7d"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt;::operator T * </td>
<td>(</td>
<td class="paramname"></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>References <a class="el" href="classRefCountPointer.html#abdad2242b59d285fe75208c5fed5a90a">RefCountPointer&lt; T &gt;::_p</a>.</p>
</div>
</div>
<a class="anchor" id="a19c9fb1b8719f5b010c0943e3594296a"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt;::operator-&gt; </td>
<td>(</td>
<td class="paramname"></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">
</div>
</div>
<a class="anchor" id="aaed4cb34420ba9a5190e142cdb3c786d"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classRefCountPointer.html">RefCountPointer</a>&amp; <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt;::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>o</em></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>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="abdad2242b59d285fe75208c5fed5a90a"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt;::_p</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Referenced by <a class="el" href="classRefCountPointer.html#aad04c84082534aa246546bd0c3355848">RefCountPointer&lt; const Item &gt;::get()</a>, <a class="el" href="classRefCountPointer.html#a62f15012bafcbe02f0dcdbd2c0a749ee">RefCountPointer&lt; const Item &gt;::isNull()</a>, <a class="el" href="classRefCountPointer.html#a1de8e3bd6a0af6661047049983243e1c">RefCountPointer&lt; const Item &gt;::notNull()</a>, <a class="el" href="classRefCountPointer.html#a6522f582ede5cc4a36fc990bf5165f7d">RefCountPointer&lt; T &gt;::operator T *()</a>, <a class="el" href="classRefCountPointer.html#a19c9fb1b8719f5b010c0943e3594296a">RefCountPointer&lt; const Item &gt;::operator-&gt;()</a>, <a class="el" href="classRefCountPointer.html#aaed4cb34420ba9a5190e142cdb3c786d">RefCountPointer&lt; const Item &gt;::operator=()</a>, <a class="el" href="classRefCountPointer.html#a19e599ede99710afeca89ba65cdcb2a1">RefCountPointer&lt; const Item &gt;::RefCountPointer()</a>, and <a class="el" href="classRefCountPointer.html#a15aac5f85305a123c357bbddf5030ef3">RefCountPointer&lt; const Item &gt;::~RefCountPointer()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ReferenceCounted_8hpp_source.html">ReferenceCounted.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>