<!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::RefPointer 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_pointer.html">RefPointer</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="classost_1_1_ref_pointer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ost::RefPointer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classost_1_1_pointer.html" title="Used to create and manage referece counted pointers. ">Pointer</a> to reference counted objects.
<a href="classost_1_1_ref_pointer.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:a76e5c23d1db92f2a334253747ec86ce4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#a76e5c23d1db92f2a334253747ec86ce4">RefPointer</a> ()</td></tr>
<tr class="memdesc:a76e5c23d1db92f2a334253747ec86ce4"><td class="mdescLeft"> </td><td class="mdescRight">Create an unattached pointer. <a href="#a76e5c23d1db92f2a334253747ec86ce4">More...</a><br/></td></tr>
<tr class="separator:a76e5c23d1db92f2a334253747ec86ce4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a80c9557ad1f14596bb0040fa10ea04bf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#a80c9557ad1f14596bb0040fa10ea04bf">RefPointer</a> (<a class="el" href="classost_1_1_ref_object.html">RefObject</a> *obj)</td></tr>
<tr class="memdesc:a80c9557ad1f14596bb0040fa10ea04bf"><td class="mdescLeft"> </td><td class="mdescRight">Create a pointer attached to a reference counted object. <a href="#a80c9557ad1f14596bb0040fa10ea04bf">More...</a><br/></td></tr>
<tr class="separator:a80c9557ad1f14596bb0040fa10ea04bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a81ab48c97d11e952061ae222dfde6128"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#a81ab48c97d11e952061ae222dfde6128">RefPointer</a> (const <a class="el" href="classost_1_1_ref_pointer.html">RefPointer</a> &ptr)</td></tr>
<tr class="memdesc:a81ab48c97d11e952061ae222dfde6128"><td class="mdescLeft"> </td><td class="mdescRight">A copy constructor. <a href="#a81ab48c97d11e952061ae222dfde6128">More...</a><br/></td></tr>
<tr class="separator:a81ab48c97d11e952061ae222dfde6128"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46bf017249d0f9b5cf5ff908dc4b964e"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#a46bf017249d0f9b5cf5ff908dc4b964e">~RefPointer</a> ()</td></tr>
<tr class="separator:a46bf017249d0f9b5cf5ff908dc4b964e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa78d62e51e06b7b3bdd994515d0dd643"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_ref_pointer.html">RefPointer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#aa78d62e51e06b7b3bdd994515d0dd643">operator=</a> (const <a class="el" href="classost_1_1_ref_object.html">RefObject</a> &<a class="el" href="classost_1_1_ref_pointer.html#a1a3547c5e0bd7f72b08dd98586545ca8">ref</a>)</td></tr>
<tr class="separator:aa78d62e51e06b7b3bdd994515d0dd643"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6eef018020e060eb767e32217f080c4c"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#a6eef018020e060eb767e32217f080c4c">operator*</a> () const </td></tr>
<tr class="separator:a6eef018020e060eb767e32217f080c4c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c917f739b1a3394e4046ae87582b68d"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#a1c917f739b1a3394e4046ae87582b68d">operator-></a> () const </td></tr>
<tr class="separator:a1c917f739b1a3394e4046ae87582b68d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa46b6b5050d934ae90a38d79c4ec740c"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#aa46b6b5050d934ae90a38d79c4ec740c">getObject</a> (void) const </td></tr>
<tr class="separator:aa46b6b5050d934ae90a38d79c4ec740c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af45f0a5749479e8b138c87bfd5025c65"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#af45f0a5749479e8b138c87bfd5025c65">operator!</a> () const </td></tr>
<tr class="separator:af45f0a5749479e8b138c87bfd5025c65"><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:ab44f3d899d0ecad72570cb1bc6fca0ea"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#ab44f3d899d0ecad72570cb1bc6fca0ea">detach</a> (void)</td></tr>
<tr class="memdesc:ab44f3d899d0ecad72570cb1bc6fca0ea"><td class="mdescLeft"> </td><td class="mdescRight">Detach current object, for example, when changing pointer. <a href="#ab44f3d899d0ecad72570cb1bc6fca0ea">More...</a><br/></td></tr>
<tr class="separator:ab44f3d899d0ecad72570cb1bc6fca0ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ed9fa3807843a175185e99cd97b1600"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#a2ed9fa3807843a175185e99cd97b1600">enterLock</a> (void)</td></tr>
<tr class="memdesc:a2ed9fa3807843a175185e99cd97b1600"><td class="mdescLeft"> </td><td class="mdescRight">Patch point for mutex in derived class. <a href="#a2ed9fa3807843a175185e99cd97b1600">More...</a><br/></td></tr>
<tr class="separator:a2ed9fa3807843a175185e99cd97b1600"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa765f7f9d45d021dfc308f30b509f959"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#aa765f7f9d45d021dfc308f30b509f959">leaveLock</a> (void)</td></tr>
<tr class="memdesc:aa765f7f9d45d021dfc308f30b509f959"><td class="mdescLeft"> </td><td class="mdescRight">Patch point for a mutex in derived class. <a href="#aa765f7f9d45d021dfc308f30b509f959">More...</a><br/></td></tr>
<tr class="separator:aa765f7f9d45d021dfc308f30b509f959"><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:a1a3547c5e0bd7f72b08dd98586545ca8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_ref_object.html">RefObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_ref_pointer.html#a1a3547c5e0bd7f72b08dd98586545ca8">ref</a></td></tr>
<tr class="separator:a1a3547c5e0bd7f72b08dd98586545ca8"><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 class="el" href="classost_1_1_pointer.html" title="Used to create and manage referece counted pointers. ">Pointer</a> to reference counted objects. </p>
<p>This is a non-template form of a reference count smart pointer, and so uses common code. This can be subclassed to return explicit object types.</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> <a class="el" href="classost_1_1_pointer.html" title="Used to create and manage referece counted pointers. ">Pointer</a> to reference count managed objects. </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a76e5c23d1db92f2a334253747ec86ce4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ost::RefPointer::RefPointer </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">
<p>Create an unattached pointer. </p>
</div>
</div>
<a class="anchor" id="a80c9557ad1f14596bb0040fa10ea04bf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::RefPointer::RefPointer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_ref_object.html">RefObject</a> * </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a pointer attached to a reference counted object. </p>
<p>Object being referenced. </p>
</div>
</div>
<a class="anchor" id="a81ab48c97d11e952061ae222dfde6128"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::RefPointer::RefPointer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_ref_pointer.html">RefPointer</a> & </td>
<td class="paramname"><em>ptr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>A copy constructor. </p>
<p><a class="el" href="classost_1_1_pointer.html" title="Used to create and manage referece counted pointers. ">Pointer</a> being copied. </p>
</div>
</div>
<a class="anchor" id="a46bf017249d0f9b5cf5ff908dc4b964e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ost::RefPointer::~RefPointer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab44f3d899d0ecad72570cb1bc6fca0ea"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ost::RefPointer::detach </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">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Detach current object, for example, when changing pointer. </p>
</div>
</div>
<a class="anchor" id="a2ed9fa3807843a175185e99cd97b1600"></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::RefPointer::enterLock </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">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Patch point for mutex in derived class. </p>
<p>This may often be a single static mutex shared by a managed type. </p>
</div>
</div>
<a class="anchor" id="aa46b6b5050d934ae90a38d79c4ec740c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ost::RefPointer::getObject </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aa765f7f9d45d021dfc308f30b509f959"></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::RefPointer::leaveLock </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">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Patch point for a mutex in derived class. </p>
<p>This may often be a single static mutex shared by a managed type. </p>
</div>
</div>
<a class="anchor" id="af45f0a5749479e8b138c87bfd5025c65"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::RefPointer::operator! </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a6eef018020e060eb767e32217f080c4c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void* ost::RefPointer::operator* </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="a1c917f739b1a3394e4046ae87582b68d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void* ost::RefPointer::operator-> </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="aa78d62e51e06b7b3bdd994515d0dd643"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_ref_pointer.html">RefPointer</a>& ost::RefPointer::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_ref_object.html">RefObject</a> & </td>
<td class="paramname"><em>ref</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a1a3547c5e0bd7f72b08dd98586545ca8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_ref_object.html">RefObject</a>* ost::RefPointer::ref</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>
