XQuilla/docs/simple-api/classRefCountPointer.html

328 lines
16 KiB
HTML
Raw Normal View History

2020-02-17 22:05:20 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
2020-02-17 22:11:31 +01:00
<title>XQilla Simple API Documentation</title>
2020-02-17 22:05:20 +01:00
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
2020-02-17 22:11:31 +01:00
<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>
2020-02-17 22:17:06 +01:00
<!-- Generated by Doxygen 1.5.5 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.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 class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
2020-02-17 22:05:20 +01:00
<h1>RefCountPointer&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="RefCountPointer" -->Super class of all the reference counted wrappers for Items.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="ReferenceCounted_8hpp-source.html">ReferenceCounted.hpp</a>&gt;</code>
2020-02-17 22:17:06 +01:00
<p>
<div class="dynheader">
Inheritance diagram for RefCountPointer&lt; T &gt;:</div>
<div class="dynsection">
<p><center><img src="classRefCountPointer__inherit__graph.png" border="0" usemap="#RefCountPointer_3_01T_01_4__inherit__map" alt="Inheritance graph"></center>
<map name="RefCountPointer_3_01T_01_4__inherit__map">
<area shape="rect" href="classRefCountPointer.html" title="RefCountPointer\&lt; Item \&gt;" alt="" coords="5,94,171,118"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
2020-02-17 22:05:20 +01:00
<p>
<a href="classRefCountPointer-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#19e599ede99710afeca89ba65cdcb2a1">RefCountPointer</a> (T *p=0)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T2&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#541717a9c467461b75ab8118ae6f9ed9">RefCountPointer</a> (const <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T2 &gt; &amp;o)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#deb7f9624e9181b2b04950c38d4a8fce">RefCountPointer</a> (const <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt; &amp;o)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classRefCountPointer.html">RefCountPointer</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#aed4cb34420ba9a5190e142cdb3c786d">operator=</a> (const <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt; &amp;o)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#15aac5f85305a123c357bbddf5030ef3">~RefCountPointer</a> ()</td></tr>
2020-02-17 22:17:06 +01:00
<tr><td class="memItemLeft" nowrap align="right" valign="top">T *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#19c9fb1b8719f5b010c0943e3594296a">operator-&gt;</a> () const </td></tr>
2020-02-17 22:05:20 +01:00
2020-02-17 22:17:06 +01:00
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#6522f582ede5cc4a36fc990bf5165f7d">operator T *</a> () const </td></tr>
2020-02-17 22:05:20 +01:00
2020-02-17 22:17:06 +01:00
<tr><td class="memItemLeft" nowrap align="right" valign="top">T *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#ad04c84082534aa246546bd0c3355848">get</a> () const </td></tr>
2020-02-17 22:05:20 +01:00
2020-02-17 22:17:06 +01:00
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#62f15012bafcbe02f0dcdbd2c0a749ee">isNull</a> () const </td></tr>
2020-02-17 22:05:20 +01:00
2020-02-17 22:17:06 +01:00
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#1de8e3bd6a0af6661047049983243e1c">notNull</a> () const </td></tr>
2020-02-17 22:05:20 +01:00
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">T *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRefCountPointer.html#bdad2242b59d285fe75208c5fed5a90a">_p</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class T&gt;<br>
class RefCountPointer&lt; T &gt;</h3>
2020-02-17 22:17:06 +01:00
Super class of all the reference counted wrappers for Items. <dl compact><dt><b>Examples: </b></dt><dd>
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:17:06 +01:00
<a class="el" href="simple-basic_8cpp-example.html#_a4">simple-basic.cpp</a>, and <a class="el" href="simple-context-item_8cpp-example.html#_a5">simple-context-item.cpp</a>.</dl><hr><h2>Constructor &amp; Destructor Documentation</h2>
2020-02-17 22:10:06 +01:00
<a class="anchor" name="19e599ede99710afeca89ba65cdcb2a1"></a><!-- doxytag: member="RefCountPointer::RefCountPointer" ref="19e599ede99710afeca89ba65cdcb2a1" args="(T *p=0)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:10:06 +01:00
<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 *&nbsp;</td>
<td class="paramname"> <em>p</em> = <code>0</code> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline]</code></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:10:06 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:10:06 +01:00
</div>
</div><p>
<a class="anchor" name="541717a9c467461b75ab8118ae6f9ed9"></a><!-- doxytag: member="RefCountPointer::RefCountPointer" ref="541717a9c467461b75ab8118ae6f9ed9" args="(const RefCountPointer&lt; T2 &gt; &amp;o)" -->
<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="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:10:06 +01:00
<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;&nbsp;</td>
<td class="paramname"> <em>o</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline]</code></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:10:06 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:10:06 +01:00
</div>
</div><p>
<a class="anchor" name="deb7f9624e9181b2b04950c38d4a8fce"></a><!-- doxytag: member="RefCountPointer::RefCountPointer" ref="deb7f9624e9181b2b04950c38d4a8fce" args="(const RefCountPointer&lt; T &gt; &amp;o)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:10:06 +01:00
<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;&nbsp;</td>
<td class="paramname"> <em>o</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline]</code></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:10:06 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:10:06 +01:00
</div>
</div><p>
<a class="anchor" name="15aac5f85305a123c357bbddf5030ef3"></a><!-- doxytag: member="RefCountPointer::~RefCountPointer" ref="15aac5f85305a123c357bbddf5030ef3" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:10:06 +01:00
<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>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline]</code></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:10:06 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:10:06 +01:00
</div>
</div><p>
2020-02-17 22:05:20 +01:00
<hr><h2>Member Function Documentation</h2>
2020-02-17 22:10:06 +01:00
<a class="anchor" name="aed4cb34420ba9a5190e142cdb3c786d"></a><!-- doxytag: member="RefCountPointer::operator=" ref="aed4cb34420ba9a5190e142cdb3c786d" args="(const RefCountPointer&lt; T &gt; &amp;o)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:10:06 +01:00
<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;&nbsp;</td>
<td class="paramname"> <em>o</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline]</code></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:10:06 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:10:06 +01:00
</div>
</div><p>
2020-02-17 22:17:06 +01:00
<a class="anchor" name="19c9fb1b8719f5b010c0943e3594296a"></a><!-- doxytag: member="RefCountPointer::operator-&gt;" ref="19c9fb1b8719f5b010c0943e3594296a" args="() const " -->
2020-02-17 22:10:06 +01:00
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:10:06 +01:00
<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>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [inline]</code></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:10:06 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:10:06 +01:00
</div>
</div><p>
2020-02-17 22:17:06 +01:00
<a class="anchor" name="6522f582ede5cc4a36fc990bf5165f7d"></a><!-- doxytag: member="RefCountPointer::operator T *" ref="6522f582ede5cc4a36fc990bf5165f7d" args="() const " -->
2020-02-17 22:10:06 +01:00
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:10:06 +01:00
<td class="memname"><a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt;::operator T * </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [inline]</code></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:10:06 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:10:06 +01:00
2020-02-17 22:17:06 +01:00
<p>References <a class="el" href="ReferenceCounted_8hpp-source.html#l00117">RefCountPointer&lt; T &gt;::_p</a>.</p>
2020-02-17 22:10:06 +01:00
</div>
</div><p>
2020-02-17 22:17:06 +01:00
<a class="anchor" name="ad04c84082534aa246546bd0c3355848"></a><!-- doxytag: member="RefCountPointer::get" ref="ad04c84082534aa246546bd0c3355848" args="() const " -->
2020-02-17 22:10:06 +01:00
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:10:06 +01:00
<td class="memname">T* <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt;::get </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [inline]</code></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:10:06 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:10:06 +01:00
</div>
</div><p>
2020-02-17 22:17:06 +01:00
<a class="anchor" name="62f15012bafcbe02f0dcdbd2c0a749ee"></a><!-- doxytag: member="RefCountPointer::isNull" ref="62f15012bafcbe02f0dcdbd2c0a749ee" args="() const " -->
2020-02-17 22:10:06 +01:00
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:10:06 +01:00
<td class="memname">bool <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt;::isNull </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [inline]</code></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:10:06 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:10:06 +01:00
</div>
</div><p>
2020-02-17 22:17:06 +01:00
<a class="anchor" name="1de8e3bd6a0af6661047049983243e1c"></a><!-- doxytag: member="RefCountPointer::notNull" ref="1de8e3bd6a0af6661047049983243e1c" args="() const " -->
2020-02-17 22:10:06 +01:00
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:10:06 +01:00
<td class="memname">bool <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt;::notNull </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [inline]</code></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:10:06 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:10:06 +01:00
2020-02-17 22:17:06 +01:00
<p>Referenced by <a class="el" href="EventGenerator_8hpp-source.html#l00045">EventGenerator::generateAndTailCall()</a>.</p>
2020-02-17 22:10:06 +01:00
</div>
</div><p>
2020-02-17 22:05:20 +01:00
<hr><h2>Member Data Documentation</h2>
2020-02-17 22:10:06 +01:00
<a class="anchor" name="bdad2242b59d285fe75208c5fed5a90a"></a><!-- doxytag: member="RefCountPointer::_p" ref="bdad2242b59d285fe75208c5fed5a90a" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:10:06 +01:00
<td class="memname">T* <a class="el" href="classRefCountPointer.html">RefCountPointer</a>&lt; T &gt;::<a class="el" href="classRefCountPointer.html#bdad2242b59d285fe75208c5fed5a90a">_p</a><code> [protected]</code> </td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:10:06 +01:00
</div>
<div class="memdoc">
2020-02-17 22:05:20 +01:00
<p>
2020-02-17 22:10:06 +01:00
2020-02-17 22:17:06 +01:00
<p>Referenced by <a class="el" href="ReferenceCounted_8hpp-source.html#l00101">RefCountPointer&lt; Item &gt;::get()</a>, <a class="el" href="ReferenceCounted_8hpp-source.html#l00106">RefCountPointer&lt; Item &gt;::isNull()</a>, <a class="el" href="ReferenceCounted_8hpp-source.html#l00111">RefCountPointer&lt; Item &gt;::notNull()</a>, <a class="el" href="ReferenceCounted_8hpp-source.html#l00096">RefCountPointer&lt; T &gt;::operator T *()</a>, <a class="el" href="ReferenceCounted_8hpp-source.html#l00091">RefCountPointer&lt; Item &gt;::operator-&gt;()</a>, <a class="el" href="ReferenceCounted_8hpp-source.html#l00076">RefCountPointer&lt; Item &gt;::operator=()</a>, <a class="el" href="ReferenceCounted_8hpp-source.html#l00061">RefCountPointer&lt; Item &gt;::RefCountPointer()</a>, and <a class="el" href="ReferenceCounted_8hpp-source.html#l00086">RefCountPointer&lt; Item &gt;::~RefCountPointer()</a>.</p>
2020-02-17 22:10:06 +01:00
</div>
</div><p>
2020-02-17 22:05:20 +01:00
<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></ul>
2020-02-17 22:17:06 +01:00
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jan 5 19:54:23 2009 for XQilla Simple API by&nbsp;
2020-02-17 22:05:20 +01:00
<a href="http://www.doxygen.org/index.html">
2020-02-17 22:17:06 +01:00
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
2020-02-17 22:05:20 +01:00
</body>
</html>