ceph/src/boost/libs/locale/doc/html/classboost_1_1locale_1_1hold__ptr.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.6"/>
   7 <title>Boost.Locale: boost::locale::hold_ptr&lt; T &gt; Class Template Reference</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  12 <script type="text/javascript" src="resize.js"></script>
  13 <script type="text/javascript" src="navtree.js"></script>
  14 <script type="text/javascript">
  15   $(document).ready(initResizable);
  16   $(window).load(resizeHeight);
  17 </script>
  18 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  19 </head>
  20 <body>
  21 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  22 <div id="titlearea">
  23 <table cellspacing="0" cellpadding="0">
  24  <tbody>
  25  <tr style="height: 56px;">
  26   <td id="projectlogo"><img alt="Logo" src="boost-small.png"/></td>
  27   <td style="padding-left: 0.5em;">
  28    <div id="projectname">Boost.Locale
  29    </div>
  30   </td>
  31  </tr>
  32  </tbody>
  33 </table>
  34 </div>
  35 <!-- end header part -->
  36 <!-- Generated by Doxygen 1.8.6 -->
  37   <div id="navrow1" class="tabs">
  38     <ul class="tablist">
  39       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  40       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  41       <li><a href="modules.html"><span>Modules</span></a></li>
  42       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  43       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  44       <li><a href="files.html"><span>Files</span></a></li>
  45       <li><a href="examples.html"><span>Examples</span></a></li>
  46     </ul>
  47   </div>
  48   <div id="navrow2" class="tabs2">
  49     <ul class="tablist">
  50       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  51       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  52       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  53     </ul>
  54   </div>
  55 </div><!-- top -->
  56 <div id="side-nav" class="ui-resizable side-nav-resizable">
  57   <div id="nav-tree">
  58     <div id="nav-tree-contents">
  59       <div id="nav-sync" class="sync"></div>
  60     </div>
  61   </div>
  62   <div id="splitbar" style="-moz-user-select:none;"
  63        class="ui-resizable-handle">
  64   </div>
  65 </div>
  66 <script type="text/javascript">
  67 $(document).ready(function(){initNavTree('classboost_1_1locale_1_1hold__ptr.html','');});
  68 </script>
  69 <div id="doc-content">
  70 <div class="header">
  71   <div class="summary">
  72 <a href="#pub-methods">Public Member Functions</a> &#124;
  73 <a href="classboost_1_1locale_1_1hold__ptr-members.html">List of all members</a>  </div>
  74   <div class="headertitle">
  75 <div class="title">boost::locale::hold_ptr&lt; T &gt; Class Template Reference</div>  </div>
  76 </div><!--header-->
  77 <div class="contents">
  78
  79 <p>a smart pointer similar to std::auto_ptr but it is non-copyable and the underlying object has the same constness as the pointer itself (unlike an ordinary pointer).
  80  <a href="classboost_1_1locale_1_1hold__ptr.html#details">More...</a></p>
  81
  82 <p><code>#include &lt;<a class="el" href="hold__ptr_8hpp_source.html">boost/locale/hold_ptr.hpp</a>&gt;</code></p>
  83 <table class="memberdecls">
  84 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  85 Public Member Functions</h2></td></tr>
  86 <tr class="memitem:a681ee3d579435f9f2f171b830c402072"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a681ee3d579435f9f2f171b830c402072">hold_ptr</a> ()</td></tr>
  87 <tr class="separator:a681ee3d579435f9f2f171b830c402072"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88 <tr class="memitem:a0007514dc0410ccb16adf01c56874f52"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a0007514dc0410ccb16adf01c56874f52">hold_ptr</a> (T *v)</td></tr>
  89 <tr class="separator:a0007514dc0410ccb16adf01c56874f52"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90 <tr class="memitem:aace934e7a8b3f1880d1a06fa85795a48"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#aace934e7a8b3f1880d1a06fa85795a48">~hold_ptr</a> ()</td></tr>
  91 <tr class="separator:aace934e7a8b3f1880d1a06fa85795a48"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92 <tr class="memitem:a907a9385c1a15dab07aade7466620bf6"><td class="memItemLeft" align="right" valign="top">T const *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a907a9385c1a15dab07aade7466620bf6">get</a> () const </td></tr>
  93 <tr class="separator:a907a9385c1a15dab07aade7466620bf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 <tr class="memitem:a30dbc88eb9fde35198774f3ace282712"><td class="memItemLeft" align="right" valign="top">T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a30dbc88eb9fde35198774f3ace282712">get</a> ()</td></tr>
  95 <tr class="separator:a30dbc88eb9fde35198774f3ace282712"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96 <tr class="memitem:a2c8a19e35ff3c57100b24371854f31b7"><td class="memItemLeft" align="right" valign="top">T const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a2c8a19e35ff3c57100b24371854f31b7">operator*</a> () const </td></tr>
  97 <tr class="separator:a2c8a19e35ff3c57100b24371854f31b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98 <tr class="memitem:af99f3719b755b787b022253aa6f8d1c0"><td class="memItemLeft" align="right" valign="top">T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#af99f3719b755b787b022253aa6f8d1c0">operator*</a> ()</td></tr>
  99 <tr class="separator:af99f3719b755b787b022253aa6f8d1c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 100 <tr class="memitem:a7ae6b54ed5471dd9560904c7ff8a7971"><td class="memItemLeft" align="right" valign="top">T const *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a7ae6b54ed5471dd9560904c7ff8a7971">operator-&gt;</a> () const </td></tr>
 101 <tr class="separator:a7ae6b54ed5471dd9560904c7ff8a7971"><td class="memSeparator" colspan="2">&#160;</td></tr>
 102 <tr class="memitem:a474f2619452b63408e1e761f414328f4"><td class="memItemLeft" align="right" valign="top">T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a474f2619452b63408e1e761f414328f4">operator-&gt;</a> ()</td></tr>
 103 <tr class="separator:a474f2619452b63408e1e761f414328f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 104 <tr class="memitem:a2d7b2957c037589b65b2cdd4f61ebe03"><td class="memItemLeft" align="right" valign="top">T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a2d7b2957c037589b65b2cdd4f61ebe03">release</a> ()</td></tr>
 105 <tr class="separator:a2d7b2957c037589b65b2cdd4f61ebe03"><td class="memSeparator" colspan="2">&#160;</td></tr>
 106 <tr class="memitem:acb84b86bb220d663ffe13e5be9cfd72e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#acb84b86bb220d663ffe13e5be9cfd72e">reset</a> (T *p=0)</td></tr>
 107 <tr class="separator:acb84b86bb220d663ffe13e5be9cfd72e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 108 <tr class="memitem:a3e2640b5df80f86aeb68a6ee78dfd6f9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e2640b5df80f86aeb68a6ee78dfd6f9"></a>
 109 void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html#a3e2640b5df80f86aeb68a6ee78dfd6f9">swap</a> (<a class="el" href="classboost_1_1locale_1_1hold__ptr.html">hold_ptr</a> &amp;other)</td></tr>
 110 <tr class="memdesc:a3e2640b5df80f86aeb68a6ee78dfd6f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Swap two pointers. <br/></td></tr>
 111 <tr class="separator:a3e2640b5df80f86aeb68a6ee78dfd6f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 112 </table>
 113 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 114 <div class="textblock"><h3>template&lt;typename T&gt;<br/>
 115 class boost::locale::hold_ptr&lt; T &gt;</h3>
 116
 117 <p>a smart pointer similar to std::auto_ptr but it is non-copyable and the underlying object has the same constness as the pointer itself (unlike an ordinary pointer). </p>
 118 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 119 <a class="anchor" id="a681ee3d579435f9f2f171b830c402072"></a>
 120 <div class="memitem">
 121 <div class="memproto">
 122 <div class="memtemplate">
 123 template&lt;typename T&gt; </div>
 124 <table class="mlabels">
 125   <tr>
 126   <td class="mlabels-left">
 127       <table class="memname">
 128         <tr>
 129           <td class="memname"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::<a class="el" href="classboost_1_1locale_1_1hold__ptr.html">hold_ptr</a> </td>
 130           <td>(</td>
 131           <td class="paramname"></td><td>)</td>
 132           <td></td>
 133         </tr>
 134       </table>
 135   </td>
 136   <td class="mlabels-right">
 137 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 138   </tr>
 139 </table>
 140 </div><div class="memdoc">
 141 <p>Create new empty pointer </p>
 142
 143 </div>
 144 </div>
 145 <a class="anchor" id="a0007514dc0410ccb16adf01c56874f52"></a>
 146 <div class="memitem">
 147 <div class="memproto">
 148 <div class="memtemplate">
 149 template&lt;typename T&gt; </div>
 150 <table class="mlabels">
 151   <tr>
 152   <td class="mlabels-left">
 153       <table class="memname">
 154         <tr>
 155           <td class="memname"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::<a class="el" href="classboost_1_1locale_1_1hold__ptr.html">hold_ptr</a> </td>
 156           <td>(</td>
 157           <td class="paramtype">T *&#160;</td>
 158           <td class="paramname"><em>v</em></td><td>)</td>
 159           <td></td>
 160         </tr>
 161       </table>
 162   </td>
 163   <td class="mlabels-right">
 164 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
 165   </tr>
 166 </table>
 167 </div><div class="memdoc">
 168 <p>Create a pointer that holds <em>v</em>, ownership is transferred to smart pointer </p>
 169
 170 </div>
 171 </div>
 172 <a class="anchor" id="aace934e7a8b3f1880d1a06fa85795a48"></a>
 173 <div class="memitem">
 174 <div class="memproto">
 175 <div class="memtemplate">
 176 template&lt;typename T&gt; </div>
 177 <table class="mlabels">
 178   <tr>
 179   <td class="mlabels-left">
 180       <table class="memname">
 181         <tr>
 182           <td class="memname"><a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::~<a class="el" href="classboost_1_1locale_1_1hold__ptr.html">hold_ptr</a> </td>
 183           <td>(</td>
 184           <td class="paramname"></td><td>)</td>
 185           <td></td>
 186         </tr>
 187       </table>
 188   </td>
 189   <td class="mlabels-right">
 190 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 191   </tr>
 192 </table>
 193 </div><div class="memdoc">
 194 <p>Destroy smart pointer and the object it owns. </p>
 195
 196 </div>
 197 </div>
 198 <h2 class="groupheader">Member Function Documentation</h2>
 199 <a class="anchor" id="a907a9385c1a15dab07aade7466620bf6"></a>
 200 <div class="memitem">
 201 <div class="memproto">
 202 <div class="memtemplate">
 203 template&lt;typename T&gt; </div>
 204 <table class="mlabels">
 205   <tr>
 206   <td class="mlabels-left">
 207       <table class="memname">
 208         <tr>
 209           <td class="memname">T const* <a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::get </td>
 210           <td>(</td>
 211           <td class="paramname"></td><td>)</td>
 212           <td> const</td>
 213         </tr>
 214       </table>
 215   </td>
 216   <td class="mlabels-right">
 217 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 218   </tr>
 219 </table>
 220 </div><div class="memdoc">
 221 <p>Get a const pointer to the object </p>
 222
 223 </div>
 224 </div>
 225 <a class="anchor" id="a30dbc88eb9fde35198774f3ace282712"></a>
 226 <div class="memitem">
 227 <div class="memproto">
 228 <div class="memtemplate">
 229 template&lt;typename T&gt; </div>
 230 <table class="mlabels">
 231   <tr>
 232   <td class="mlabels-left">
 233       <table class="memname">
 234         <tr>
 235           <td class="memname">T* <a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::get </td>
 236           <td>(</td>
 237           <td class="paramname"></td><td>)</td>
 238           <td></td>
 239         </tr>
 240       </table>
 241   </td>
 242   <td class="mlabels-right">
 243 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 244   </tr>
 245 </table>
 246 </div><div class="memdoc">
 247 <p>Get a mutable pointer to the object </p>
 248
 249 </div>
 250 </div>
 251 <a class="anchor" id="a2c8a19e35ff3c57100b24371854f31b7"></a>
 252 <div class="memitem">
 253 <div class="memproto">
 254 <div class="memtemplate">
 255 template&lt;typename T&gt; </div>
 256 <table class="mlabels">
 257   <tr>
 258   <td class="mlabels-left">
 259       <table class="memname">
 260         <tr>
 261           <td class="memname">T const&amp; <a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::operator* </td>
 262           <td>(</td>
 263           <td class="paramname"></td><td>)</td>
 264           <td> const</td>
 265         </tr>
 266       </table>
 267   </td>
 268   <td class="mlabels-right">
 269 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 270   </tr>
 271 </table>
 272 </div><div class="memdoc">
 273 <p>Get a const reference to the object </p>
 274
 275 </div>
 276 </div>
 277 <a class="anchor" id="af99f3719b755b787b022253aa6f8d1c0"></a>
 278 <div class="memitem">
 279 <div class="memproto">
 280 <div class="memtemplate">
 281 template&lt;typename T&gt; </div>
 282 <table class="mlabels">
 283   <tr>
 284   <td class="mlabels-left">
 285       <table class="memname">
 286         <tr>
 287           <td class="memname">T&amp; <a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::operator* </td>
 288           <td>(</td>
 289           <td class="paramname"></td><td>)</td>
 290           <td></td>
 291         </tr>
 292       </table>
 293   </td>
 294   <td class="mlabels-right">
 295 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 296   </tr>
 297 </table>
 298 </div><div class="memdoc">
 299 <p>Get a mutable reference to the object </p>
 300
 301 </div>
 302 </div>
 303 <a class="anchor" id="a7ae6b54ed5471dd9560904c7ff8a7971"></a>
 304 <div class="memitem">
 305 <div class="memproto">
 306 <div class="memtemplate">
 307 template&lt;typename T&gt; </div>
 308 <table class="mlabels">
 309   <tr>
 310   <td class="mlabels-left">
 311       <table class="memname">
 312         <tr>
 313           <td class="memname">T const* <a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::operator-&gt; </td>
 314           <td>(</td>
 315           <td class="paramname"></td><td>)</td>
 316           <td> const</td>
 317         </tr>
 318       </table>
 319   </td>
 320   <td class="mlabels-right">
 321 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 322   </tr>
 323 </table>
 324 </div><div class="memdoc">
 325 <p>Get a const pointer to the object </p>
 326
 327 </div>
 328 </div>
 329 <a class="anchor" id="a474f2619452b63408e1e761f414328f4"></a>
 330 <div class="memitem">
 331 <div class="memproto">
 332 <div class="memtemplate">
 333 template&lt;typename T&gt; </div>
 334 <table class="mlabels">
 335   <tr>
 336   <td class="mlabels-left">
 337       <table class="memname">
 338         <tr>
 339           <td class="memname">T* <a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::operator-&gt; </td>
 340           <td>(</td>
 341           <td class="paramname"></td><td>)</td>
 342           <td></td>
 343         </tr>
 344       </table>
 345   </td>
 346   <td class="mlabels-right">
 347 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 348   </tr>
 349 </table>
 350 </div><div class="memdoc">
 351 <p>Get a mutable pointer to the object </p>
 352
 353 </div>
 354 </div>
 355 <a class="anchor" id="a2d7b2957c037589b65b2cdd4f61ebe03"></a>
 356 <div class="memitem">
 357 <div class="memproto">
 358 <div class="memtemplate">
 359 template&lt;typename T&gt; </div>
 360 <table class="mlabels">
 361   <tr>
 362   <td class="mlabels-left">
 363       <table class="memname">
 364         <tr>
 365           <td class="memname">T* <a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::release </td>
 366           <td>(</td>
 367           <td class="paramname"></td><td>)</td>
 368           <td></td>
 369         </tr>
 370       </table>
 371   </td>
 372   <td class="mlabels-right">
 373 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 374   </tr>
 375 </table>
 376 </div><div class="memdoc">
 377 <p>Transfer an ownership on the pointer to user </p>
 378
 379 </div>
 380 </div>
 381 <a class="anchor" id="acb84b86bb220d663ffe13e5be9cfd72e"></a>
 382 <div class="memitem">
 383 <div class="memproto">
 384 <div class="memtemplate">
 385 template&lt;typename T&gt; </div>
 386 <table class="mlabels">
 387   <tr>
 388   <td class="mlabels-left">
 389       <table class="memname">
 390         <tr>
 391           <td class="memname">void <a class="el" href="classboost_1_1locale_1_1hold__ptr.html">boost::locale::hold_ptr</a>&lt; T &gt;::reset </td>
 392           <td>(</td>
 393           <td class="paramtype">T *&#160;</td>
 394           <td class="paramname"><em>p</em> = <code>0</code></td><td>)</td>
 395           <td></td>
 396         </tr>
 397       </table>
 398   </td>
 399   <td class="mlabels-right">
 400 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 401   </tr>
 402 </table>
 403 </div><div class="memdoc">
 404 <p>Set new value to pointer, previous object is destroyed, ownership on new object is transferred </p>
 405
 406 </div>
 407 </div>
 408 <hr/>The documentation for this class was generated from the following file:<ul>
 409 <li>boost/locale/<a class="el" href="hold__ptr_8hpp_source.html">hold_ptr.hpp</a></li>
 410 </ul>
 411 </div><!-- contents -->
 412 </div><!-- doc-content -->
 413
 414     <li class="footer">
 415 &copy; Copyright 2009-2012 Artyom Beilis,  Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License</a>, Version 1.0.
 416     </li>
 417    </ul>
 418  </div>
 419 </body>
 420 </html>