<!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"/> <title>GNU CommonC++: ost::RefObject Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.3 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <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 class="tabs"> <ul> <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 class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_ref_object.html">RefObject</a> </div> </div> <div class="contents"> <h1>ost::RefObject Class Reference</h1><!-- doxytag: class="ost::RefObject" --> <p>A reference countable object. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="object_8h_source.html">object.h</a>></code></p> <p><a href="classost_1_1_ref_object-members.html">List of all members.</a></p> <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">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><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"></a><br/></td></tr> <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr> <tr><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><td class="mdescLeft"> </td><td class="mdescRight">The constructor simply initializes the count. <a href="#a7dabeed59ecca372353f66284be97dd8"></a><br/></td></tr> <tr><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><td class="mdescLeft"> </td><td class="mdescRight">The destructor is called when the reference count returns to zero. <a href="#a7c174b0ec5861a42e13daf1801ed0277"></a><br/></td></tr> <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr> <tr><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><td colspan="2"><h2>Friends</h2></td></tr> <tr><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> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <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="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> Object managed by smart pointer reference count. </dd></dl> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a7dabeed59ecca372353f66284be97dd8"></a><!-- doxytag: member="ost::RefObject::RefObject" ref="a7dabeed59ecca372353f66284be97dd8" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::RefObject::RefObject </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The constructor simply initializes the count. </p> </div> </div> <a class="anchor" id="a7c174b0ec5861a42e13daf1801ed0277"></a><!-- doxytag: member="ost::RefObject::~RefObject" ref="a7c174b0ec5861a42e13daf1801ed0277" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual ost::RefObject::~RefObject </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [protected, virtual]</code></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> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a43b6a22fa4ab33a53ce2da72877c9edb"></a><!-- doxytag: member="ost::RefObject::getObject" ref="a43b6a22fa4ab33a53ce2da72877c9edb" args="(void)=0" --> <div class="memitem"> <div class="memproto"> <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><code> [pure virtual]</code></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="return"><dt><b>Returns:</b></dt><dd>underlying object being referenced. </dd></dl> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="a0cdd998cac4e2907eb6a4e7d80ea69df"></a><!-- doxytag: member="ost::RefObject::RefPointer" ref="a0cdd998cac4e2907eb6a4e7d80ea69df" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">friend class <a class="el" href="classost_1_1_ref_pointer.html">RefPointer</a><code> [friend]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a7887ae684391ece66186f3dfbc6a35a9"></a><!-- doxytag: member="ost::RefObject::refCount" ref="a7887ae684391ece66186f3dfbc6a35a9" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned <a class="el" href="classost_1_1_ref_object.html#a7887ae684391ece66186f3dfbc6a35a9">ost::RefObject::refCount</a><code> [protected]</code></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> <hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Mar 12 10:07:41 2010 for GNU CommonC++ by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>