/usr/share/doc/libucommon-dev/a00029.html is in libucommon-doc 3.2.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 | <!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>UCommon: ucc::auto_pointer 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="main.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>Data Structures</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>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00029.html">auto_pointer</a>
</div>
</div>
<div class="contents">
<h1>ucc::auto_pointer Class Reference</h1><!-- doxytag: class="ucc::auto_pointer" -->
<p>A general purpose smart pointer helper class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00199_source.html">object.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucc::auto_pointer:</div>
<div class="dynsection">
<div class="center"><img src="a00359.png" border="0" usemap="#ucc_1_1auto__pointer_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1auto__pointer_inherit__map" id="ucc_1_1auto__pointer_inherit__map">
<area shape="rect" id="node3" href="a00015.html" title="ucc::pointer\< script \>" alt="" coords="5,83,168,112"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::auto_pointer:</div>
<div class="dynsection">
<div class="center"><img src="a00360.png" border="0" usemap="#ucc_1_1auto__pointer_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1auto__pointer_coll__map" id="ucc_1_1auto__pointer_coll__map">
<area shape="rect" id="node2" href="a00093.html" title="A common base class for all managed objects." alt="" coords="25,5,119,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#ac95edd20375edfb42b902475b6a985ec">auto_pointer</a> (const <a class="el" href="a00029.html">auto_pointer</a> &<a class="el" href="a00015.html">pointer</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an auto-pointer as a copy of another pointer. <a href="#ac95edd20375edfb42b902475b6a985ec"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#af4f70f26f6a82e200332d13e3b87f4e1">auto_pointer</a> (<a class="el" href="a00093.html">Object</a> *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an auto-pointer referencing an existing object. <a href="#af4f70f26f6a82e200332d13e3b87f4e1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#ac125bbcf8825969015ddb278af0d9277">operator bool</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if the pointer is referencing an object. <a href="#ac125bbcf8825969015ddb278af0d9277"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#a2b6a57367ff5fc9d2acea55d44e8ce2a">operator!</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if the pointer is not set. <a href="#a2b6a57367ff5fc9d2acea55d44e8ce2a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#a4f0201a2a2e8190a5b647e71b2b3de0a">operator!=</a> (<a class="el" href="a00093.html">Object</a> *object) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">test if the object being referenced is not the same as the object we specify. <a href="#a4f0201a2a2e8190a5b647e71b2b3de0a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#a41050a3253ed338943e867737c5e36c5">operator=</a> (<a class="el" href="a00093.html">Object</a> *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set our pointer to a specific object. <a href="#a41050a3253ed338943e867737c5e36c5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#a34cf314e035de694e8276999127ffcdb">operator==</a> (<a class="el" href="a00093.html">Object</a> *object) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">test if the object being referenced is the same as the object we specify. <a href="#a34cf314e035de694e8276999127ffcdb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#a2ed00073a0cdaeb20aaaab8f12782263">release</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Manually release the pointer. <a href="#a2ed00073a0cdaeb20aaaab8f12782263"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#ab59a77d0e1e219303dff403ef2e30efe">~auto_pointer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete auto pointer. <a href="#ab59a77d0e1e219303dff403ef2e30efe"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adb2161e19809361e431679db17d86df6"></a><!-- doxytag: member="ucc::auto_pointer::object" ref="adb2161e19809361e431679db17d86df6" args="" -->
<a class="el" href="a00093.html">Object</a> * </td><td class="memItemRight" valign="bottom"><b>object</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A general purpose smart pointer helper class. </p>
<p>This is particularly useful in conjunction with reference counted objects which can be managed and automatically removed from the heap when they are no longer being referenced by a smart pointer. The smart pointer itself would normally be constructed and initialized as an auto variable in a method call, and will dereference the object when the pointer falls out of scope. This is actually a helper class for the typed pointer template. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00199_source.html#l00193">193</a> of file <a class="el" href="a00199_source.html">object.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af4f70f26f6a82e200332d13e3b87f4e1"></a><!-- doxytag: member="ucc::auto_pointer::auto_pointer" ref="af4f70f26f6a82e200332d13e3b87f4e1" args="(Object *object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::auto_pointer::auto_pointer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00093.html">Object</a> * </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct an auto-pointer referencing an existing object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>we point to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac95edd20375edfb42b902475b6a985ec"></a><!-- doxytag: member="ucc::auto_pointer::auto_pointer" ref="ac95edd20375edfb42b902475b6a985ec" args="(const auto_pointer &pointer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::auto_pointer::auto_pointer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00029.html">auto_pointer</a> & </td>
<td class="paramname"> <em>pointer</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct an auto-pointer as a copy of another pointer. </p>
<p>The retention of the object being pointed to will be increased. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pointer</em> </td><td>we are a copy of. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab59a77d0e1e219303dff403ef2e30efe"></a><!-- doxytag: member="ucc::auto_pointer::~auto_pointer" ref="ab59a77d0e1e219303dff403ef2e30efe" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::auto_pointer::~auto_pointer </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete auto pointer. </p>
<p>When it falls out of scope, the retention of the object it references is reduced. If it falls to zero in a reference counted object, then the object is auto-deleted. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac125bbcf8825969015ddb278af0d9277"></a><!-- doxytag: member="ucc::auto_pointer::operator bool" ref="ac125bbcf8825969015ddb278af0d9277" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::auto_pointer::operator bool </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test if the pointer is referencing an object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the pointer is currently referencing an object. </dd></dl>
</div>
</div>
<a class="anchor" id="a2b6a57367ff5fc9d2acea55d44e8ce2a"></a><!-- doxytag: member="ucc::auto_pointer::operator!" ref="a2b6a57367ff5fc9d2acea55d44e8ce2a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::auto_pointer::operator! </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test if the pointer is not set. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the pointer is not referencing anything. </dd></dl>
</div>
</div>
<a class="anchor" id="a4f0201a2a2e8190a5b647e71b2b3de0a"></a><!-- doxytag: member="ucc::auto_pointer::operator!=" ref="a4f0201a2a2e8190a5b647e71b2b3de0a" args="(Object *object) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::auto_pointer::operator!= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00093.html">Object</a> * </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>test if the object being referenced is not the same as the object we specify. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>we compare to. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if this is not the object our pointer references. </dd></dl>
</div>
</div>
<a class="anchor" id="a41050a3253ed338943e867737c5e36c5"></a><!-- doxytag: member="ucc::auto_pointer::operator=" ref="a41050a3253ed338943e867737c5e36c5" args="(Object *object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::auto_pointer::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00093.html">Object</a> * </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set our pointer to a specific object. </p>
<p>If the pointer currently references another object, that object is released. The pointer references our new object and that new object is retained. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>to assign to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a34cf314e035de694e8276999127ffcdb"></a><!-- doxytag: member="ucc::auto_pointer::operator==" ref="a34cf314e035de694e8276999127ffcdb" args="(Object *object) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::auto_pointer::operator== </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00093.html">Object</a> * </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>test if the object being referenced is the same as the object we specify. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>we compare to. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if this is the object our pointer references. </dd></dl>
</div>
</div>
<a class="anchor" id="a2ed00073a0cdaeb20aaaab8f12782263"></a><!-- doxytag: member="ucc::auto_pointer::release" ref="a2ed00073a0cdaeb20aaaab8f12782263" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::auto_pointer::release </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Manually release the pointer. </p>
<p>This reduces the retention level of the object and resets the pointer to point to nobody. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00199_source.html">object.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:25 2010 for UCommon 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>
|