<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GNU CommonC++: ost::RefObject Class 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>
<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 style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU CommonC++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main 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 List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceost.html">ost</a></li><li class="navelem"><a class="el" href="classost_1_1_ref_object.html">RefObject</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#friends">Friends</a> |
<a href="classost_1_1_ref_object-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ost::RefObject Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A reference countable object.
<a href="classost_1_1_ref_object.html#details">More...</a></p>
<p><code>#include <<a class="el" href="object_8h_source.html">object.h</a>></code></p>
<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:a43b6a22fa4ab33a53ce2da72877c9edb"><td class="memItemLeft" align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_object.html#a43b6a22fa4ab33a53ce2da72877c9edb">getObject</a> (void)=0</td></tr>
<tr class="memdesc:a43b6a22fa4ab33a53ce2da72877c9edb"><td class="mdescLeft"> </td><td class="mdescRight">The actual object being managed can be returned by this method as a void and then recast to the actual type. <a href="#a43b6a22fa4ab33a53ce2da72877c9edb">More...</a><br/></td></tr>
<tr class="separator:a43b6a22fa4ab33a53ce2da72877c9edb"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a7dabeed59ecca372353f66284be97dd8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_object.html#a7dabeed59ecca372353f66284be97dd8">RefObject</a> ()</td></tr>
<tr class="memdesc:a7dabeed59ecca372353f66284be97dd8"><td class="mdescLeft"> </td><td class="mdescRight">The constructor simply initializes the count. <a href="#a7dabeed59ecca372353f66284be97dd8">More...</a><br/></td></tr>
<tr class="separator:a7dabeed59ecca372353f66284be97dd8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7c174b0ec5861a42e13daf1801ed0277"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_object.html#a7c174b0ec5861a42e13daf1801ed0277">~RefObject</a> ()</td></tr>
<tr class="memdesc:a7c174b0ec5861a42e13daf1801ed0277"><td class="mdescLeft"> </td><td class="mdescRight">The destructor is called when the reference count returns to zero. <a href="#a7c174b0ec5861a42e13daf1801ed0277">More...</a><br/></td></tr>
<tr class="separator:a7c174b0ec5861a42e13daf1801ed0277"><td class="memSeparator" colspan="2"> </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:a7887ae684391ece66186f3dfbc6a35a9"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_object.html#a7887ae684391ece66186f3dfbc6a35a9">refCount</a></td></tr>
<tr class="separator:a7887ae684391ece66186f3dfbc6a35a9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a0cdd998cac4e2907eb6a4e7d80ea69df"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_object.html#a0cdd998cac4e2907eb6a4e7d80ea69df">RefPointer</a></td></tr>
<tr class="separator:a0cdd998cac4e2907eb6a4e7d80ea69df"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A reference countable object. </p>
<p>This is used in association with smart pointers (<a class="el" href="classost_1_1_ref_pointer.html" title="Pointer to reference counted objects. ">RefPointer</a>).</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'ut'+'ele'+'ph'+'ony'+'.o'+'rg'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>telep<span style="display: none;">.nosp@m.</span>hony<span style="display: none;">.nosp@m.</span>.org</a> Object managed by smart pointer reference count. </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7dabeed59ecca372353f66284be97dd8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ost::RefObject::RefObject </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 class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The constructor simply initializes the count. </p>
</div>
</div>
<a class="anchor" id="a7c174b0ec5861a42e13daf1801ed0277"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ost::RefObject::~RefObject </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The destructor is called when the reference count returns to zero. </p>
<p>This is done through a virtual destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a43b6a22fa4ab33a53ce2da72877c9edb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void* ost::RefObject::getObject </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The actual object being managed can be returned by this method as a void and then recast to the actual type. </p>
<p>This removes the need to dynamic cast from <a class="el" href="classost_1_1_ref_object.html" title="A reference countable object. ">RefObject</a> and the dependence on rtti this implies.</p>
<dl class="section return"><dt>Returns</dt><dd>underlying object being referenced. </dd></dl>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="a0cdd998cac4e2907eb6a4e7d80ea69df"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classost_1_1_ref_pointer.html">RefPointer</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a7887ae684391ece66186f3dfbc6a35a9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned ost::RefObject::refCount</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="object_8h_source.html">object.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 17 2013 23:24:57 for GNU CommonC++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
