XQuilla/docs/simple-api/classReferenceCounted.html

171 lines
12 KiB
HTML
Raw Normal View History

2020-02-17 21:05:20 +00: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 21:11:31 +00:00
<title>XQilla Simple API Documentation</title>
2020-02-17 21:05:20 +00:00
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
2020-02-17 21:11:31 +00: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 21:23:16 +00:00
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
2020-02-17 21:19:57 +00:00
<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>
2020-02-17 21:23:16 +00:00
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</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>
2020-02-17 21:19:57 +00:00
</ul>
</div>
</div>
<div class="contents">
2020-02-17 21:23:16 +00:00
<h1>ReferenceCounted Class Reference</h1><!-- doxytag: class="ReferenceCounted" -->
2020-02-17 21:19:57 +00:00
<p>Super class for reference counted classes.
<a href="#_details">More...</a></p>
2020-02-17 21:05:20 +00:00
2020-02-17 21:19:57 +00:00
<p><code>#include &lt;<a class="el" href="ReferenceCounted_8hpp_source.html">ReferenceCounted.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ReferenceCounted:</div>
2020-02-17 21:23:16 +00:00
<div class="dynsection">
2020-02-17 21:19:57 +00:00
<div class="center"><img src="classReferenceCounted__inherit__graph.png" border="0" usemap="#ReferenceCounted_inherit__map" alt="Inheritance graph"/></div>
<map name="ReferenceCounted_inherit__map" id="ReferenceCounted_inherit__map">
2020-02-17 21:23:16 +00:00
<area shape="rect" id="node3" href="classEventGenerator.html" title="EventGenerator" alt="" coords="207,259,337,288"/><area shape="rect" id="node7" href="classItem.html" title="Item" alt="" coords="245,325,299,355"/><area shape="rect" id="node61" href="classTimezone.html" title="Timezone" alt="" coords="228,379,316,408"/><area shape="rect" id="node5" href="classASTNodeEventGenerator.html" title="ASTNodeEventGenerator" alt="" coords="387,245,579,275"/><area shape="rect" id="node9" href="classAnyAtomicType.html" title="AnyAtomicType" alt="" coords="420,299,545,328"/><area shape="rect" id="node57" href="classFunctionRef.html" title="FunctionRef" alt="" coords="432,352,533,381"/><area shape="rect" id="node59" href="classNode.html" title="Node" alt="" coords="455,405,511,435"/><area shape="rect" id="node11" href="classATAnySimpleType.html" title="This class represents the atomic types (ie, the simple types which are not list or..." alt="" coords="659,5,795,35"/><area shape="rect" id="node13" href="classATAnyURIOrDerived.html" title="ATAnyURIOrDerived" alt="" coords="649,59,804,88"/><area shape="rect" id="node15" href="classATBase64BinaryOrDerived.html" title="ATBase64BinaryOrDerived" alt="" coords="628,112,825,141"/><area shape="rect" id="node17" href="classATBooleanOrDerived.html" title="ATBooleanOrDerived" alt="" coords="647,165,807,195"/><area shape="rect" id="node19" href="classATDurationOrDerived.html" title="ATDurationOrDerived" alt="" coords="644,219,809,248"/><area shape="rect" id="node21" href="classATHexBinaryOrDerived.html" title="ATHexBinaryOrDerived" alt="" coords="639,272,815,301"/><area shape="rect" id="node23" href="classATNotationOrDerived.html" title="ATNotationOrDerived" alt="" coords="644,325,809,355"/><area shape="rect" id="node25" href="classATQNameOrDerived.html" title="ATQNameOrDerived" alt="" coords="648,379,805,408"/><area shape="rect" id="node27" href="classATStringOrDerived.html" title="ATStringOrDerived" alt="" coords="653,432,800,461"/><area shape="rect" id="node29" href="classATUntypedAtomic.html" title="ATUntypedAtomic" alt="" coords="656,485,797,515"/><area shape="rect" id="node31" href="classDateOrTimeType.html" title="DateOrTimeType" alt="" coords="659,539,795,568"/><area shape="rect" id="node49" href="classNumeric.html" title="Numeric" alt="" coords="688,779,765,808"/><area shape="rect" id="node33" href="classATDateOrDerived.html" title="ATDateOrDerived" alt="" coords="897,325,1039,355"/><area shape="rect" id="node35" href="classATDateTimeOrDerived.html" title="ATDateTimeOrDerived" alt="" coords="881,379,1055,408"/><area shape="rect" id="node37" href="classATGDayOrDerived.html" title="ATGDayOrDerived" alt="" coords="896,432,1040,461"/><area shape="rect" id="node39" href="classATGMonthDayOrDerived.html" title="ATGMonthDayOrDerived" alt="" coords="875,485,1061,515"/><area shape="rect" id="node41" href="classATGMonthOrDerived.html" title="ATGMonthOrDerived" alt="" coords="888,539,1048,568"/><area shape="rect" id="node43" href="classATGYearMonthOrDerived.html" title="ATGYearMonthOrDerived" alt="" coords="875,592,1061,621"/><area shape="rect" id="node45" href="classATGYearOrDerived.html" title="ATGYearOrDerived" alt="" coords="896,645,1040,675"/><area shape="rect" id="node47" href="classATTimeOrDerived.html" title="ATTimeOrDerived" alt="" coords="899,699,1037,728"/><area shape="rect" id="node51" href="classATDecimalOrDerived.html" title="ATDecimalOrDerived" alt="" coords="887,752,1049,781"/><area shape="rect" id="node53" href="classATDoubleOrDerived.html" title="ATDoubleOrDerived" alt="" coords="891,805,1045,835"/><area shape="rect" id="node55" href="classATFloatOrDerived.html" title="ATFloatOrDerived" alt="" coords="897,859,1039,888"/></map>
2020-02-17 21:19:57 +00:00
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
2020-02-17 21:05:20 +00:00
2020-02-17 21:19:57 +00:00
<p><a href="classReferenceCounted-members.html">List of all members.</a></p>
2020-02-17 21:23:16 +00:00
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCounted.html#a5dc30ae895897b5008dc71ea26f175a1">ReferenceCounted</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCounted.html#a039b1f45b252a226c55598f31e3993cc">~ReferenceCounted</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCounted.html#a386d6aab0473c14a32ce81226b939cb3">incrementRefCount</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Increment the reference count. <a href="#a386d6aab0473c14a32ce81226b939cb3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCounted.html#a426ce234c4797e7150f44a9bb50537b5">decrementRefCount</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Decrement the reference count, deleting if it becomes zero. <a href="#a426ce234c4797e7150f44a9bb50537b5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCounted.html#a462eca1b13abf41350ef3d969435db2c">getRefCount</a> () const </td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCounted.html#a09e5d033e5224cd8b94cdc061cb56fe0">_ref_count</a></td></tr>
2020-02-17 21:05:20 +00:00
</table>
2020-02-17 21:19:57 +00:00
<hr/><a name="_details"></a><h2>Detailed Description</h2>
2020-02-17 21:23:16 +00:00
<p>Super class for reference counted classes. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
2020-02-17 21:19:57 +00:00
<a class="anchor" id="a5dc30ae895897b5008dc71ea26f175a1"></a><!-- doxytag: member="ReferenceCounted::ReferenceCounted" ref="a5dc30ae895897b5008dc71ea26f175a1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 21:05:20 +00:00
<tr>
2020-02-17 21:19:57 +00:00
<td class="memname">ReferenceCounted::ReferenceCounted </td>
<td>(</td>
2020-02-17 21:23:16 +00:00
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
2020-02-17 21:19:57 +00:00
<td><code> [inline]</code></td>
2020-02-17 21:05:20 +00:00
</tr>
</table>
2020-02-17 21:19:57 +00:00
</div>
<div class="memdoc">
2020-02-17 21:05:20 +00:00
2020-02-17 21:19:57 +00:00
</div>
</div>
<a class="anchor" id="a039b1f45b252a226c55598f31e3993cc"></a><!-- doxytag: member="ReferenceCounted::~ReferenceCounted" ref="a039b1f45b252a226c55598f31e3993cc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 21:05:20 +00:00
<tr>
2020-02-17 21:19:57 +00:00
<td class="memname">virtual ReferenceCounted::~ReferenceCounted </td>
<td>(</td>
2020-02-17 21:23:16 +00:00
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
2020-02-17 21:19:57 +00:00
<td><code> [inline, virtual]</code></td>
2020-02-17 21:05:20 +00:00
</tr>
</table>
2020-02-17 21:19:57 +00:00
</div>
<div class="memdoc">
2020-02-17 21:05:20 +00:00
2020-02-17 21:19:57 +00:00
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a426ce234c4797e7150f44a9bb50537b5"></a><!-- doxytag: member="ReferenceCounted::decrementRefCount" ref="a426ce234c4797e7150f44a9bb50537b5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 21:05:20 +00:00
<tr>
2020-02-17 21:19:57 +00:00
<td class="memname">virtual void ReferenceCounted::decrementRefCount </td>
<td>(</td>
2020-02-17 21:23:16 +00:00
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
2020-02-17 21:19:57 +00:00
<td> const<code> [inline, virtual]</code></td>
2020-02-17 21:05:20 +00:00
</tr>
</table>
2020-02-17 21:19:57 +00:00
</div>
<div class="memdoc">
2020-02-17 21:05:20 +00:00
2020-02-17 21:19:57 +00:00
<p>Decrement the reference count, deleting if it becomes zero. </p>
2020-02-17 21:22:42 +00:00
</div>
</div>
<a class="anchor" id="a462eca1b13abf41350ef3d969435db2c"></a><!-- doxytag: member="ReferenceCounted::getRefCount" ref="a462eca1b13abf41350ef3d969435db2c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int ReferenceCounted::getRefCount </td>
<td>(</td>
2020-02-17 21:23:16 +00:00
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
2020-02-17 21:22:42 +00:00
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
2020-02-17 21:19:57 +00:00
</div>
</div>
<a class="anchor" id="a386d6aab0473c14a32ce81226b939cb3"></a><!-- doxytag: member="ReferenceCounted::incrementRefCount" ref="a386d6aab0473c14a32ce81226b939cb3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 21:05:20 +00:00
<tr>
2020-02-17 21:19:57 +00:00
<td class="memname">void ReferenceCounted::incrementRefCount </td>
<td>(</td>
2020-02-17 21:23:16 +00:00
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
2020-02-17 21:19:57 +00:00
<td> const<code> [inline]</code></td>
2020-02-17 21:05:20 +00:00
</tr>
</table>
2020-02-17 21:19:57 +00:00
</div>
<div class="memdoc">
2020-02-17 21:05:20 +00:00
2020-02-17 21:19:57 +00:00
<p>Increment the reference count. </p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a09e5d033e5224cd8b94cdc061cb56fe0"></a><!-- doxytag: member="ReferenceCounted::_ref_count" ref="a09e5d033e5224cd8b94cdc061cb56fe0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 21:05:20 +00:00
<tr>
2020-02-17 21:19:57 +00:00
<td class="memname">unsigned int <a class="el" href="classReferenceCounted.html#a09e5d033e5224cd8b94cdc061cb56fe0">ReferenceCounted::_ref_count</a><code> [protected]</code></td>
2020-02-17 21:05:20 +00:00
</tr>
</table>
2020-02-17 21:19:57 +00:00
</div>
<div class="memdoc">
2020-02-17 21:05:20 +00:00
2020-02-17 21:19:57 +00:00
</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>
2020-02-17 21:23:16 +00:00
<hr size="1"/><address style="text-align: right;"><small>Generated on 18 May 2015 for XQilla Simple API by&nbsp;
2020-02-17 21:05:20 +00:00
<a href="http://www.doxygen.org/index.html">
2020-02-17 21:23:16 +00:00
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
2020-02-17 21:05:20 +00:00
</body>
</html>