<!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"/>
<title>ICU 52.1: icu::LocalPointer< T > Class Template 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">ICU 52.1
 <span id="projectnumber">52.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceicu.html">icu</a></li><li class="navelem"><a class="el" href="classicu_1_1LocalPointer.html">LocalPointer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">icu::LocalPointer< T > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>"Smart pointer" class, deletes objects via the standard C++ delete operator.
<a href="classicu_1_1LocalPointer.html#details">More...</a></p>
<p><code>#include <<a class="el" href="localpointer_8h_source.html">localpointer.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for icu::LocalPointer< T >:</div>
<div class="dyncontent">
<div class="center">
<img src="classicu_1_1LocalPointer.png" usemap="#icu::LocalPointer< T >_map" alt=""/>
<map id="icu::LocalPointer< T >_map" name="icu::LocalPointer< T >_map">
<area href="classicu_1_1LocalPointerBase.html" title=""Smart pointer" base class; do not use directly: use LocalPointer etc." alt="icu::LocalPointerBase< T >" shape="rect" coords="0,0,165,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:afe77e30ccfa6690a9e1cc534362d9133"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1LocalPointer.html#afe77e30ccfa6690a9e1cc534362d9133">LocalPointer</a> (T *p=<a class="el" href="LETypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>)</td></tr>
<tr class="memdesc:afe77e30ccfa6690a9e1cc534362d9133"><td class="mdescLeft"> </td><td class="mdescRight">Constructor takes ownership. <a href="#afe77e30ccfa6690a9e1cc534362d9133"></a><br/></td></tr>
<tr class="memitem:abad99a07de7d1b542f5d03611a36e438"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1LocalPointer.html#abad99a07de7d1b542f5d03611a36e438">~LocalPointer</a> ()</td></tr>
<tr class="memdesc:abad99a07de7d1b542f5d03611a36e438"><td class="mdescLeft"> </td><td class="mdescRight">Destructor deletes the object it owns. <a href="#abad99a07de7d1b542f5d03611a36e438"></a><br/></td></tr>
<tr class="memitem:aed4b7cb380ffca74a62db4add5fb39af"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1LocalPointer.html#aed4b7cb380ffca74a62db4add5fb39af">adoptInstead</a> (T *p)</td></tr>
<tr class="memdesc:aed4b7cb380ffca74a62db4add5fb39af"><td class="mdescLeft"> </td><td class="mdescRight">Deletes the object it owns, and adopts (takes ownership of) the one passed in. <a href="#aed4b7cb380ffca74a62db4add5fb39af"></a><br/></td></tr>
<tr class="inherit_header pub_methods_classicu_1_1LocalPointerBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classicu_1_1LocalPointerBase')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classicu_1_1LocalPointerBase.html">icu::LocalPointerBase< T ></a></td></tr>
<tr class="memitem:a3b2cdd3fc8d9b5f10387b2001999f8e9 inherit pub_methods_classicu_1_1LocalPointerBase"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1LocalPointerBase.html#a3b2cdd3fc8d9b5f10387b2001999f8e9">LocalPointerBase</a> (T *p=<a class="el" href="LETypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>)</td></tr>
<tr class="memdesc:a3b2cdd3fc8d9b5f10387b2001999f8e9 inherit pub_methods_classicu_1_1LocalPointerBase"><td class="mdescLeft"> </td><td class="mdescRight">Constructor takes ownership. <a href="#a3b2cdd3fc8d9b5f10387b2001999f8e9"></a><br/></td></tr>
<tr class="memitem:af2837be3ff07fc55f1b0cc9f982e1ffa inherit pub_methods_classicu_1_1LocalPointerBase"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1LocalPointerBase.html#af2837be3ff07fc55f1b0cc9f982e1ffa">~LocalPointerBase</a> ()</td></tr>
<tr class="memdesc:af2837be3ff07fc55f1b0cc9f982e1ffa inherit pub_methods_classicu_1_1LocalPointerBase"><td class="mdescLeft"> </td><td class="mdescRight">Destructor deletes the object it owns. <a href="#af2837be3ff07fc55f1b0cc9f982e1ffa"></a><br/></td></tr>
<tr class="memitem:a9d414477891695f38e3ddab64e27fcc3 inherit pub_methods_classicu_1_1LocalPointerBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1LocalPointerBase.html#a9d414477891695f38e3ddab64e27fcc3">isNull</a> () const </td></tr>
<tr class="memdesc:a9d414477891695f38e3ddab64e27fcc3 inherit pub_methods_classicu_1_1LocalPointerBase"><td class="mdescLeft"> </td><td class="mdescRight">NULL check. <a href="#a9d414477891695f38e3ddab64e27fcc3"></a><br/></td></tr>
<tr class="memitem:ad8d547a362aa5e8f23e16b55e93c927e inherit pub_methods_classicu_1_1LocalPointerBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1LocalPointerBase.html#ad8d547a362aa5e8f23e16b55e93c927e">isValid</a> () const </td></tr>
<tr class="memdesc:ad8d547a362aa5e8f23e16b55e93c927e inherit pub_methods_classicu_1_1LocalPointerBase"><td class="mdescLeft"> </td><td class="mdescRight">NULL check. <a href="#ad8d547a362aa5e8f23e16b55e93c927e"></a><br/></td></tr>
<tr class="memitem:a04d46f03725cb94f23c38594b8f26b6f inherit pub_methods_classicu_1_1LocalPointerBase"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1LocalPointerBase.html#a04d46f03725cb94f23c38594b8f26b6f">operator==</a> (const T *other) const </td></tr>
<tr class="memdesc:a04d46f03725cb94f23c38594b8f26b6f inherit pub_methods_classicu_1_1LocalPointerBase"><td class="mdescLeft"> </td><td class="mdescRight">Comparison with a simple pointer, so that existing code with ==NULL need not be changed. <a href="#a04d46f03725cb94f23c38594b8f26b6f"></a><br/></td></tr>
<tr class="memitem:a5a2b7c4ba35801eb9c4ebc16ba89a866 inherit pub_methods_classicu_1_1LocalPointerBase"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1LocalPointerBase.html#a5a2b7c4ba35801eb9c4ebc16ba89a866">operator!=</a> (const T *other) const </td></tr>
<tr class="memdesc:a5a2b7c4ba35801eb9c4ebc16ba89a866 inherit pub_methods_classicu_1_1LocalPointerBase"><td class="mdescLeft"> </td><td class="mdescRight">Comparison with a simple pointer, so that existing code with !=NULL need not be changed. <a href="#a5a2b7c4ba35801eb9c4ebc16ba89a866"></a><br/></td></tr>
<tr class="memitem:a8cd944572ef521130da0a857c2969941 inherit pub_methods_classicu_1_1LocalPointerBase"><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1LocalPointerBase.html#a8cd944572ef521130da0a857c2969941">getAlias</a> () const </td></tr>
<tr class="memdesc:a8cd944572ef521130da0a857c2969941 inherit pub_methods_classicu_1_1LocalPointerBase"><td class="mdescLeft"> </td><td class="mdescRight">Access without ownership change. <a href="#a8cd944572ef521130da0a857c2969941"></a><br/></td></tr>
<tr class="memitem:a9c1c0b24386f47b5150c8782f21b17b4 inherit pub_methods_classicu_1_1LocalPointerBase"><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1LocalPointerBase.html#a9c1c0b24386f47b5150c8782f21b17b4">operator*</a> () const </td></tr>
<tr class="memdesc:a9c1c0b24386f47b5150c8782f21b17b4 inherit pub_methods_classicu_1_1LocalPointerBase"><td class="mdescLeft"> </td><td class="mdescRight">Access without ownership change. <a href="#a9c1c0b24386f47b5150c8782f21b17b4"></a><br/></td></tr>
<tr class="memitem:a1cdf52aa4f39e5afd16f0c5390164fee inherit pub_methods_classicu_1_1LocalPointerBase"><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1LocalPointerBase.html#a1cdf52aa4f39e5afd16f0c5390164fee">operator-></a> () const </td></tr>
<tr class="memdesc:a1cdf52aa4f39e5afd16f0c5390164fee inherit pub_methods_classicu_1_1LocalPointerBase"><td class="mdescLeft"> </td><td class="mdescRight">Access without ownership change. <a href="#a1cdf52aa4f39e5afd16f0c5390164fee"></a><br/></td></tr>
<tr class="memitem:a7b2f09d61c50f2693e328c69bb534af1 inherit pub_methods_classicu_1_1LocalPointerBase"><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1LocalPointerBase.html#a7b2f09d61c50f2693e328c69bb534af1">orphan</a> ()</td></tr>
<tr class="memdesc:a7b2f09d61c50f2693e328c69bb534af1 inherit pub_methods_classicu_1_1LocalPointerBase"><td class="mdescLeft"> </td><td class="mdescRight">Gives up ownership; the internal pointer becomes NULL. <a href="#a7b2f09d61c50f2693e328c69bb534af1"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_classicu_1_1LocalPointerBase"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classicu_1_1LocalPointerBase')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classicu_1_1LocalPointerBase.html">icu::LocalPointerBase< T ></a></td></tr>
<tr class="memitem:aac2cdd14fff3f7a8c594ee0826b2d278 inherit pro_attribs_classicu_1_1LocalPointerBase"><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1LocalPointerBase.html#aac2cdd14fff3f7a8c594ee0826b2d278">ptr</a></td></tr>
<tr class="memdesc:aac2cdd14fff3f7a8c594ee0826b2d278 inherit pro_attribs_classicu_1_1LocalPointerBase"><td class="mdescLeft"> </td><td class="mdescRight">Actual pointer. <a href="#aac2cdd14fff3f7a8c594ee0826b2d278"></a><br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<typename T><br/>
class icu::LocalPointer< T ></h3>
<p>"Smart pointer" class, deletes objects via the standard C++ delete operator. </p>
<p>For most methods see the <a class="el" href="classicu_1_1LocalPointerBase.html" title=""Smart pointer" base class; do not use directly: use LocalPointer etc.">LocalPointerBase</a> base class.</p>
<p>Usage example: </p>
<div class="fragment"><div class="line">LocalPointer<UnicodeString> s(<span class="keyword">new</span> UnicodeString((<a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809" title="Define UChar32 as a type for single Unicode code points.">UChar32</a>)0x50005));</div>
<div class="line">int32_t length=s->length(); <span class="comment">// 2</span></div>
<div class="line"><a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac" title="Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t), or wchar_t if that is ...">UChar</a> lead=s->charAt(0); <span class="comment">// 0xd900</span></div>
<div class="line"><span class="keywordflow">if</span>(some condition) { <span class="keywordflow">return</span>; } <span class="comment">// no need to explicitly delete the pointer</span></div>
<div class="line">s.adoptInstead(<span class="keyword">new</span> UnicodeString((<a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac" title="Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t), or wchar_t if that is ...">UChar</a>)0xfffc));</div>
<div class="line">length=s->length(); <span class="comment">// 1</span></div>
<div class="line"><span class="comment">// no need to explicitly delete the pointer</span></div>
</div><!-- fragment --><dl class="section see"><dt>See Also</dt><dd><a class="el" href="classicu_1_1LocalPointerBase.html" title=""Smart pointer" base class; do not use directly: use LocalPointer etc.">LocalPointerBase</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000206">Stable:</a></b></dt><dd>ICU 4.4 </dd></dl>
<p>Definition at line <a class="el" href="localpointer_8h_source.html#l00186">186</a> of file <a class="el" href="localpointer_8h_source.html">localpointer.h</a>.</p>
</div><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="afe77e30ccfa6690a9e1cc534362d9133"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointer.html">icu::LocalPointer</a>< T >::<a class="el" href="classicu_1_1LocalPointer.html">LocalPointer</a> </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"><em>p</em> = <code><a class="el" href="LETypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a></code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor takes ownership. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>simple pointer to an object that is adopted </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000220">Stable:</a></b></dt><dd>ICU 4.4 </dd></dl>
<p>Definition at line <a class="el" href="localpointer_8h_source.html#l00193">193</a> of file <a class="el" href="localpointer_8h_source.html">localpointer.h</a>.</p>
</div>
</div>
<a class="anchor" id="abad99a07de7d1b542f5d03611a36e438"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1LocalPointer.html">icu::LocalPointer</a>< T >::~<a class="el" href="classicu_1_1LocalPointer.html">LocalPointer</a> </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>Destructor deletes the object it owns. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000221">Stable:</a></b></dt><dd>ICU 4.4 </dd></dl>
<p>Definition at line <a class="el" href="localpointer_8h_source.html#l00198">198</a> of file <a class="el" href="localpointer_8h_source.html">localpointer.h</a>.</p>
</div>
</div>
<h2>Member Function Documentation</h2>
<a class="anchor" id="aed4b7cb380ffca74a62db4add5fb39af"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classicu_1_1LocalPointer.html">icu::LocalPointer</a>< T >::adoptInstead </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"><em>p</em></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>Deletes the object it owns, and adopts (takes ownership of) the one passed in. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>simple pointer to an object that is adopted </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000222">Stable:</a></b></dt><dd>ICU 4.4 </dd></dl>
<p>Reimplemented from <a class="el" href="classicu_1_1LocalPointerBase.html#ad5bff662cda72c0f9d1da8f626725dcc">icu::LocalPointerBase< T ></a>.</p>
<p>Definition at line <a class="el" href="localpointer_8h_source.html#l00207">207</a> of file <a class="el" href="localpointer_8h_source.html">localpointer.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="localpointer_8h_source.html">localpointer.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Oct 4 2013 14:10:24 for ICU 52.1 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>
