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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Loki: Loki::StrongPtr< T, Strong, OwnershipPolicy, ConversionPolicy, CheckingPolicy, ResetPolicy, DeletePolicy, ConstnessPolicy > Class Template Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<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 id="current"><a href="classes.html"><span>Classes</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="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</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="nav">
<a class="el" href="a00764.html">Loki</a>::<a class="el" href="a00719.html">StrongPtr</a></div>
<h1>Loki::StrongPtr< T, Strong, OwnershipPolicy, ConversionPolicy, CheckingPolicy, ResetPolicy, DeletePolicy, ConstnessPolicy > Class Template Reference<br>
<small>
[<a class="el" href="a00781.html">Smart pointers</a>]</small>
</h1><!-- doxytag: class="Loki::StrongPtr" --><code>#include <StrongPtr.h></code>
<p>
<a href="a00258.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="a00719.html#e493c465f8e0067db7fa98271be5a0c6">Merge</a> (<a class="el" href="a00719.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="a00719.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="a00719.html#c3afffc8a90f5369c895a220bcc6db34">Unlock</a> (void)</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="a00719.html#a3de2b1fa05e1345761a2227164967ec">operator==</a> (const <a class="el" href="a00719.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="a00719.html#08e3d6dd0e6731fc1d304ec30f46c67f">operator!=</a> (const <a class="el" href="a00719.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="a00719.html#d79a42e24523a741ca408fc06a6b496b">operator<</a> (const <a class="el" href="a00719.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="a00719.html#b2690debb3f60c59954f63328f00fa56">operator></a> (const <a class="el" href="a00719.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="a00719.html#586e58be1f85d76fbe0b43170ed5da14">operator<=</a> (const <a class="el" href="a00719.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="a00719.html#477cf3ea79e8d0f6dff7172372533873">operator>=</a> (const <a class="el" href="a00719.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::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="a00721.html">TwoRefCounts</a>, </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ConversionPolicy</em> </td><td>default = <a class="el" href="a00671.html">DisallowConversion</a>, </td></tr>
<tr><td valign="top"></td><td valign="top"><em>CheckingPolicy</em> </td><td>default = <a class="el" href="a00639.html">AssertCheck</a>, </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ResetPolicy</em> </td><td>default = <a class="el" href="a00643.html">CantResetWithStrong</a>, </td></tr>
<tr><td valign="top"></td><td valign="top"><em>DeletePolicy</em> </td><td>default = <a class="el" href="a00663.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>
<p>
<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::LOKI_DEFAULT_CONSTNESS> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00719.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 width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Locks <a class="el" href="a00719.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::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="a00719.html">Loki::StrongPtr</a>< T, Strong, OwnershipPolicy, ConversionPolicy, CheckingPolicy, ResetPolicy, DeletePolicy, ConstnessPolicy >::Merge </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00719.html">StrongPtr</a>< T1, S1, OP1, CP1, KP1, RP1, DP1, CNP1 > & </td>
<td class="paramname"> <em>rhs</em> </td>
<td> ) </td>
<td width="100%"><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 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::LOKI_DEFAULT_CONSTNESS> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00719.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 width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Unlocks <a class="el" href="a00719.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>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 15:14:44 2006 for Loki by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
|
