<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Loki: Loki::StrongPtr< T, Strong, OwnershipPolicy, ConversionPolicy, CheckingPolicy, ResetPolicy, DeletePolicy, ConstnessPolicy > 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.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</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>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<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 class="navpath"><a class="el" href="a00192.html">Loki</a>::<a class="el" href="a00135.html">StrongPtr</a>
</div>
</div>
<div class="contents">
<h1>Loki::StrongPtr< T, Strong, OwnershipPolicy, ConversionPolicy, CheckingPolicy, ResetPolicy, DeletePolicy, ConstnessPolicy > Class Template Reference<br>
<small>
[<a class="el" href="a00218.html">Smart pointers</a>]</small>
</h1><!-- doxytag: class="Loki::StrongPtr" --><code>#include <StrongPtr.h></code>
<p>
<p>
<a href="a00440.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<typename T1 , bool S1, class OP1 , class CP1 , template< class > class KP1, template< class > class RP1, template< class > class DP1, template< class > class CNP1> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00135.html#e493c465f8e0067db7fa98271be5a0c6">Merge</a> (<a class="el" href="a00135.html">StrongPtr</a>< T1, S1, OP1, CP1, KP1, RP1, DP1, CNP1 > &rhs)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00135.html#70ad60678f72611567acc26fc718fed6">Lock</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00135.html#c3afffc8a90f5369c895a220bcc6db34">Unlock</a> (void)</td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="0c197e9b4f68669529435577357ffa57"></a><!-- doxytag: member="Loki::StrongPtr::Equals" ref="0c197e9b4f68669529435577357ffa57" args="(const T1 *p) const " -->
template<class T1 > </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00135.html#0c197e9b4f68669529435577357ffa57">Equals</a> (const T1 *p) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Helper function which can be called to avoid exposing GetPointer function. <br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="baea90f6e505a2afc662fe07c9c117fa"></a><!-- doxytag: member="Loki::StrongPtr::LessThan" ref="baea90f6e505a2afc662fe07c9c117fa" args="(const T1 *p) const " -->
template<class T1 > </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00135.html#baea90f6e505a2afc662fe07c9c117fa">LessThan</a> (const T1 *p) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Helper function which can be called to avoid exposing GetPointer function. <br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="f43b2cde389f926c16e166c418b13040"></a><!-- doxytag: member="Loki::StrongPtr::GreaterThan" ref="f43b2cde389f926c16e166c418b13040" args="(const T1 *p) const " -->
template<class T1 > </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00135.html#f43b2cde389f926c16e166c418b13040">GreaterThan</a> (const T1 *p) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Helper function which can be called to avoid exposing GetPointer function. <br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="a3de2b1fa05e1345761a2227164967ec"></a><!-- doxytag: member="Loki::StrongPtr::operator==" ref="a3de2b1fa05e1345761a2227164967ec" args="(const StrongPtr< T1, S1, OP1, CP1, KP1, RP1, DP1, CNP1 > &rhs) const " -->
template<typename T1 , bool S1, class OP1 , class CP1 , template< class > class KP1, template< class > class RP1, template< class > class DP1, template< class > class CNP1> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00135.html#a3de2b1fa05e1345761a2227164967ec">operator==</a> (const <a class="el" href="a00135.html">StrongPtr</a>< T1, S1, OP1, CP1, KP1, RP1, DP1, CNP1 > &rhs) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Equality comparison operator is templated to handle ambiguity. <br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="08e3d6dd0e6731fc1d304ec30f46c67f"></a><!-- doxytag: member="Loki::StrongPtr::operator!=" ref="08e3d6dd0e6731fc1d304ec30f46c67f" args="(const StrongPtr< T1, S1, OP1, CP1, KP1, RP1, DP1, CNP1 > &rhs) const " -->
template<typename T1 , bool S1, class OP1 , class CP1 , template< class > class KP1, template< class > class RP1, template< class > class DP1, template< class > class CNP1> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00135.html#08e3d6dd0e6731fc1d304ec30f46c67f">operator!=</a> (const <a class="el" href="a00135.html">StrongPtr</a>< T1, S1, OP1, CP1, KP1, RP1, DP1, CNP1 > &rhs) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Inequality comparison operator is templated to handle ambiguity. <br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="d79a42e24523a741ca408fc06a6b496b"></a><!-- doxytag: member="Loki::StrongPtr::operator<" ref="d79a42e24523a741ca408fc06a6b496b" args="(const StrongPtr< T1, S1, OP1, CP1, KP1, RP1, DP1, CNP1 > &rhs) const " -->
template<typename T1 , bool S1, class OP1 , class CP1 , template< class > class KP1, template< class > class RP1, template< class > class DP1, template< class > class CNP1> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00135.html#d79a42e24523a741ca408fc06a6b496b">operator<</a> (const <a class="el" href="a00135.html">StrongPtr</a>< T1, S1, OP1, CP1, KP1, RP1, DP1, CNP1 > &rhs) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Less-than comparison operator is templated to handle ambiguity. <br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="b2690debb3f60c59954f63328f00fa56"></a><!-- doxytag: member="Loki::StrongPtr::operator>" ref="b2690debb3f60c59954f63328f00fa56" args="(const StrongPtr< T1, S1, OP1, CP1, KP1, RP1, DP1, CNP1 > &rhs) const " -->
template<typename T1 , bool S1, class OP1 , class CP1 , template< class > class KP1, template< class > class RP1, template< class > class DP1, template< class > class CNP1> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00135.html#b2690debb3f60c59954f63328f00fa56">operator></a> (const <a class="el" href="a00135.html">StrongPtr</a>< T1, S1, OP1, CP1, KP1, RP1, DP1, CNP1 > &rhs) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Greater-than comparison operator is templated to handle ambiguity. <br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="586e58be1f85d76fbe0b43170ed5da14"></a><!-- doxytag: member="Loki::StrongPtr::operator<=" ref="586e58be1f85d76fbe0b43170ed5da14" args="(const StrongPtr< T1, S1, OP1, CP1, KP1, RP1, DP1, CNP1 > &rhs) const " -->
template<typename T1 , bool S1, class OP1 , class CP1 , template< class > class KP1, template< class > class RP1, template< class > class DP1, template< class > class CNP1> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00135.html#586e58be1f85d76fbe0b43170ed5da14">operator<=</a> (const <a class="el" href="a00135.html">StrongPtr</a>< T1, S1, OP1, CP1, KP1, RP1, DP1, CNP1 > &rhs) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Less-than-or-equal-to operator is templated to handle ambiguity. <br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="477cf3ea79e8d0f6dff7172372533873"></a><!-- doxytag: member="Loki::StrongPtr::operator>=" ref="477cf3ea79e8d0f6dff7172372533873" args="(const StrongPtr< T1, S1, OP1, CP1, KP1, RP1, DP1, CNP1 > &rhs) const " -->
template<typename T1 , bool S1, class OP1 , class CP1 , template< class > class KP1, template< class > class RP1, template< class > class DP1, template< class > class CNP1> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00135.html#477cf3ea79e8d0f6dff7172372533873">operator>=</a> (const <a class="el" href="a00135.html">StrongPtr</a>< T1, S1, OP1, CP1, KP1, RP1, DP1, CNP1 > &rhs) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Greater-than-or-equal-to operator is templated to handle ambiguity. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<typename T, bool Strong = true, class OwnershipPolicy = Loki::TwoRefCounts, class ConversionPolicy = Loki::DisallowConversion, template< class > class CheckingPolicy = Loki::AssertCheck, template< class > class ResetPolicy = Loki::CantResetWithStrong, template< class > class DeletePolicy = Loki::DeleteSingle, template< class > class ConstnessPolicy = LOKI_DEFAULT_CONSTNESS><br>
class Loki::StrongPtr< T, Strong, OwnershipPolicy, ConversionPolicy, CheckingPolicy, ResetPolicy, DeletePolicy, ConstnessPolicy ></h3>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Strong</em> </td><td>default = true, </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OwnershipPolicy</em> </td><td>default = <a class="el" href="a00139.html">TwoRefCounts</a>, </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ConversionPolicy</em> </td><td>default = <a class="el" href="a00050.html">DisallowConversion</a>, </td></tr>
<tr><td valign="top"></td><td valign="top"><em>CheckingPolicy</em> </td><td>default = <a class="el" href="a00010.html">AssertCheck</a>, </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ResetPolicy</em> </td><td>default = <a class="el" href="a00015.html">CantResetWithStrong</a>, </td></tr>
<tr><td valign="top"></td><td valign="top"><em>DeletePolicy</em> </td><td>default = <a class="el" href="a00042.html">DeleteSingle</a> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ConstnessPolicy</em> </td><td>default = LOKI_DEFAULT_CONSTNESS </td></tr>
</table>
</dl>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="70ad60678f72611567acc26fc718fed6"></a><!-- doxytag: member="Loki::StrongPtr::Lock" ref="70ad60678f72611567acc26fc718fed6" args="(void)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T, bool Strong = true, class OwnershipPolicy = Loki::TwoRefCounts, class ConversionPolicy = Loki::DisallowConversion, template< class > class CheckingPolicy = Loki::AssertCheck, template< class > class ResetPolicy = Loki::CantResetWithStrong, template< class > class DeletePolicy = Loki::DeleteSingle, template< class > class ConstnessPolicy = LOKI_DEFAULT_CONSTNESS> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00135.html">Loki::StrongPtr</a>< T, Strong, OwnershipPolicy, ConversionPolicy, CheckingPolicy, ResetPolicy, DeletePolicy, ConstnessPolicy >::Lock </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>
Locks <a class="el" href="a00135.html">StrongPtr</a> so other threads can't affect pointer. Requires the OwnershipPolicy to have Lock function.
</div>
</div><p>
<a class="anchor" name="e493c465f8e0067db7fa98271be5a0c6"></a><!-- doxytag: member="Loki::StrongPtr::Merge" ref="e493c465f8e0067db7fa98271be5a0c6" args="(StrongPtr< T1, S1, OP1, CP1, KP1, RP1, DP1, CNP1 > &rhs)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T, bool Strong = true, class OwnershipPolicy = Loki::TwoRefCounts, class ConversionPolicy = Loki::DisallowConversion, template< class > class CheckingPolicy = Loki::AssertCheck, template< class > class ResetPolicy = Loki::CantResetWithStrong, template< class > class DeletePolicy = Loki::DeleteSingle, template< class > class ConstnessPolicy = LOKI_DEFAULT_CONSTNESS> </div>
<div class="memtemplate">
template<typename T1 , bool S1, class OP1 , class CP1 , template< class > class KP1, template< class > class RP1, template< class > class DP1, template< class > class CNP1> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="a00135.html">Loki::StrongPtr</a>< T, Strong, OwnershipPolicy, ConversionPolicy, CheckingPolicy, ResetPolicy, DeletePolicy, ConstnessPolicy >::Merge </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00135.html">StrongPtr</a>< T1, S1, OP1, CP1, KP1, RP1, DP1, CNP1 > & </td>
<td class="paramname"> <em>rhs</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Merges ownership of two StrongPtr's that point to same shared object but are not copointers. Requires Merge function in OwnershipPolicy. <dl class="return" compact><dt><b>Returns:</b></dt><dd>True for success, false if not pointer to same object. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c3afffc8a90f5369c895a220bcc6db34"></a><!-- doxytag: member="Loki::StrongPtr::Unlock" ref="c3afffc8a90f5369c895a220bcc6db34" args="(void)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T, bool Strong = true, class OwnershipPolicy = Loki::TwoRefCounts, class ConversionPolicy = Loki::DisallowConversion, template< class > class CheckingPolicy = Loki::AssertCheck, template< class > class ResetPolicy = Loki::CantResetWithStrong, template< class > class DeletePolicy = Loki::DeleteSingle, template< class > class ConstnessPolicy = LOKI_DEFAULT_CONSTNESS> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00135.html">Loki::StrongPtr</a>< T, Strong, OwnershipPolicy, ConversionPolicy, CheckingPolicy, ResetPolicy, DeletePolicy, ConstnessPolicy >::Unlock </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>
Unlocks <a class="el" href="a00135.html">StrongPtr</a> so other threads can affect pointer. Requires the OwnershipPolicy to have Unlock function.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>StrongPtr.h</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 29 18:51:45 2009 for Loki by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>
