/usr/share/doc/libucommon-dev/a00015.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 | <!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::pointer< T, P > Class Template 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="a00015.html">pointer</a>
</div>
</div>
<div class="contents">
<h1>ucc::pointer< T, P > Class Template Reference</h1><!-- doxytag: class="ucc::pointer" --><!-- doxytag: inherits="ucc::P" -->
<p>Typed smart pointer class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00199_source.html">object.h</a>></code></p>
<p>Inherits ucc::P.</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">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00015.html#a3b1062c5c79bc12acb7c96e9a1c900de">get</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get pointer to object. <a href="#a3b1062c5c79bc12acb7c96e9a1c900de"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00015.html#ae92a0fdd8e1966f4cf06d65878615015">operator()</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reference object we are pointing to through function reference. <a href="#ae92a0fdd8e1966f4cf06d65878615015"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00015.html#a75bd1224aee905d8b84e8e29de8751d3">operator*</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reference object we are pointing to through pointer indirection. <a href="#a75bd1224aee905d8b84e8e29de8751d3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00015.html#a81917b88caedaee68369e11f67cc4711">operator++</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate our pointer if we reference an array on the heap. <a href="#a81917b88caedaee68369e11f67cc4711"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00015.html#aedc19cc1c834bdf0f5e12ce3be569760">operator--</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate our pointer if we reference an array on the heap. <a href="#aedc19cc1c834bdf0f5e12ce3be569760"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00015.html#a49652c02e12056be835402b28c757bdf">operator-></a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reference member of object we are pointing to. <a href="#a49652c02e12056be835402b28c757bdf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00015.html#aa47d83815e3857180912cdbe9d81b5f9">operator=</a> (T *typed)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform assignment operator to existing object. <a href="#aa47d83815e3857180912cdbe9d81b5f9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00015.html#a7df16336d7e8de8a01bd9a59393e57f4">pointer</a> (T *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a pointer with a reference to a heap object. <a href="#a7df16336d7e8de8a01bd9a59393e57f4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a04dfaf161b844e6a19357289b8f416a3"></a><!-- doxytag: member="ucc::pointer::pointer" ref="a04dfaf161b844e6a19357289b8f416a3" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00015.html#a04dfaf161b844e6a19357289b8f416a3">pointer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a pointer with no reference. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class T, class P = auto_pointer><br/>
class ucc::pointer< T, P ></h3>
<p>Typed smart pointer class. </p>
<p>This is used to manage references to a specific typed object on the heap that is derived from the base <a class="el" href="a00093.html" title="A common base class for all managed objects.">Object</a> class. This is most commonly used to manage references to reference counted heap objects so their heap usage can be auto-managed while there is active references to such objects. Pointers are usually created on the stack frame and used to reference an object during the life of a member function. They can be created in other objects that live on the heap and can be used to maintain active references so long as the object they are contained in remains in scope as well. </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#l00482">482</a> of file <a class="el" href="a00199_source.html">object.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7df16336d7e8de8a01bd9a59393e57f4"></a><!-- doxytag: member="ucc::pointer::pointer" ref="a7df16336d7e8de8a01bd9a59393e57f4" args="(T *object)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class P = auto_pointer> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00015.html">ucc::pointer</a>< T, P >::<a class="el" href="a00015.html">pointer</a> </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a pointer with a reference to a heap 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 are referencing. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00199_source.html#l00494">494</a> of file <a class="el" href="a00199_source.html">object.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3b1062c5c79bc12acb7c96e9a1c900de"></a><!-- doxytag: member="ucc::pointer::get" ref="a3b1062c5c79bc12acb7c96e9a1c900de" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class P = auto_pointer> </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00015.html">ucc::pointer</a>< T, P >::get </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get pointer to object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer or NULL if we are not referencing an object. </dd></dl>
<p>Definition at line <a class="el" href="a00199_source.html#l00521">521</a> of file <a class="el" href="a00199_source.html">object.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae92a0fdd8e1966f4cf06d65878615015"></a><!-- doxytag: member="ucc::pointer::operator()" ref="ae92a0fdd8e1966f4cf06d65878615015" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class P = auto_pointer> </div>
<table class="memname">
<tr>
<td class="memname">T& <a class="el" href="a00015.html">ucc::pointer</a>< T, P >::operator() </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reference object we are pointing to through function reference. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>object we are pointing to. </dd></dl>
<p>Definition at line <a class="el" href="a00199_source.html#l00507">507</a> of file <a class="el" href="a00199_source.html">object.h</a>.</p>
</div>
</div>
<a class="anchor" id="a75bd1224aee905d8b84e8e29de8751d3"></a><!-- doxytag: member="ucc::pointer::operator*" ref="a75bd1224aee905d8b84e8e29de8751d3" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class P = auto_pointer> </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00015.html">ucc::pointer</a>< T, P >::operator* </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reference object we are pointing to through pointer indirection. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to object we are pointing to. </dd></dl>
<p>Definition at line <a class="el" href="a00199_source.html#l00500">500</a> of file <a class="el" href="a00199_source.html">object.h</a>.</p>
</div>
</div>
<a class="anchor" id="a81917b88caedaee68369e11f67cc4711"></a><!-- doxytag: member="ucc::pointer::operator++" ref="a81917b88caedaee68369e11f67cc4711" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class P = auto_pointer> </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00015.html">ucc::pointer</a>< T, P >::operator++ </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Iterate our pointer if we reference an array on the heap. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>next object in array. </dd></dl>
<p>Definition at line <a class="el" href="a00199_source.html#l00528">528</a> of file <a class="el" href="a00199_source.html">object.h</a>.</p>
</div>
</div>
<a class="anchor" id="aedc19cc1c834bdf0f5e12ce3be569760"></a><!-- doxytag: member="ucc::pointer::operator--" ref="aedc19cc1c834bdf0f5e12ce3be569760" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class P = auto_pointer> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00015.html">ucc::pointer</a>< T, P >::operator-- </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Iterate our pointer if we reference an array on the heap. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>previous object in array. </dd></dl>
<p>Definition at line <a class="el" href="a00199_source.html#l00535">535</a> of file <a class="el" href="a00199_source.html">object.h</a>.</p>
</div>
</div>
<a class="anchor" id="a49652c02e12056be835402b28c757bdf"></a><!-- doxytag: member="ucc::pointer::operator->" ref="a49652c02e12056be835402b28c757bdf" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class P = auto_pointer> </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00015.html">ucc::pointer</a>< T, P >::operator-> </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reference member of object we are pointing to. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>reference to member of pointed object. </dd></dl>
<p>Definition at line <a class="el" href="a00199_source.html#l00514">514</a> of file <a class="el" href="a00199_source.html">object.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa47d83815e3857180912cdbe9d81b5f9"></a><!-- doxytag: member="ucc::pointer::operator=" ref="aa47d83815e3857180912cdbe9d81b5f9" args="(T *typed)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class P = auto_pointer> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00015.html">ucc::pointer</a>< T, P >::operator= </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"> <em>typed</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Perform assignment operator to 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>typed</em> </td><td>object to assign. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00199_source.html#l00542">542</a> of file <a class="el" href="a00199_source.html">object.h</a>.</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:39 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>
|