doc/oscl_html/oscl__shared__ptr_8h_source.html


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

<!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>oscl: oscl_shared_ptr.h Source File</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="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<h1>oscl_shared_ptr.h</h1><a href="oscl__shared__ptr_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// -*- c++ -*-</span>
<a name="l00002"></a>00002 <span class="comment">// = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =</span>
<a name="l00003"></a>00003 
<a name="l00004"></a>00004 <span class="comment">//         O S C L _ S H A R E D _ P T R</span>
<a name="l00005"></a>00005 
<a name="l00006"></a>00006 <span class="comment">// = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =</span>
<a name="l00007"></a>00007 
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef OSCL_SHARED_PTR_H_INCLUDED</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define OSCL_SHARED_PTR_H_INCLUDED</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef OSCL_BASE_H_INCLUDED</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="oscl__base_8h.html" title="The file oscl_base.h is the public header that should be included to pick up the...">oscl_base.h</a>&quot;</span>
<a name="l00024"></a>00024 <span class="preprocessor">#endif</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#ifndef OSCL_REFCOUNTER_H_INCLUDED</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="oscl__refcounter_8h.html" title="A general purpose reference counter to object lifetimes.">oscl_refcounter.h</a>&quot;</span>
<a name="l00028"></a>00028 <span class="preprocessor">#endif</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span>
<a name="l00030"></a><a class="code" href="group__osclbase.html#ga52df9cd30fae914a27342a653bc56e37">00030</a> <span class="preprocessor">#define OSCL_DISABLE_WARNING_RETURN_TYPE_NOT_UDT</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="osclconfig__compiler__warnings_8h.html" title="This file contains the ability to turn off/on compiler warnings.">osclconfig_compiler_warnings.h</a>&quot;</span>
<a name="l00032"></a>00032 
<a name="l00034"></a>00034 <span class="keyword">template</span> &lt;<span class="keyword">class</span> TheClass&gt;
<a name="l00035"></a><a class="code" href="classOsclSharedPtr.html">00035</a> <span class="keyword">class </span><a class="code" href="classOsclSharedPtr.html" title="A parameterized smart pointer class.">OsclSharedPtr</a>
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037     <span class="keyword">public</span>:
<a name="l00039"></a><a class="code" href="classOsclSharedPtr.html#ae25920e397d7a7f38fd2d06432cc22f2">00039</a>         <a class="code" href="classOsclSharedPtr.html#ae25920e397d7a7f38fd2d06432cc22f2" title="Constructor.">OsclSharedPtr</a>() :
<a name="l00040"></a>00040                 mpRep(<a class="code" href="group__osclbase.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4" title="The NULL_TERM_CHAR is used to terminate c-style strings.">NULL</a>), refcnt(<a class="code" href="group__osclbase.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4" title="The NULL_TERM_CHAR is used to terminate c-style strings.">NULL</a>) {}
<a name="l00041"></a>00041 
<a name="l00043"></a>00043 
<a name="l00046"></a><a class="code" href="group__osclbase.html#gade51c7acffa07b9f8ba607b6d612e97c">00046</a>         <a class="code" href="classOsclSharedPtr.html#ae25920e397d7a7f38fd2d06432cc22f2" title="Constructor.">OsclSharedPtr</a>(TheClass* inClassPtr, <a class="code" href="classOsclRefCounter.html">OsclRefCounter</a>* in_refcnt) :
<a name="l00047"></a>00047                 mpRep(inClassPtr), refcnt(in_refcnt) {};
<a name="l00048"></a>00048 
<a name="l00049"></a>00049 
<a name="l00051"></a><a class="code" href="group__osclbase.html#gab8cdae055fa3ab08039b0e022753b0d6">00051</a>         <a class="code" href="classOsclSharedPtr.html#ae25920e397d7a7f38fd2d06432cc22f2" title="Constructor.">OsclSharedPtr</a>(<span class="keyword">const</span> <a class="code" href="classOsclSharedPtr.html" title="A parameterized smart pointer class.">OsclSharedPtr</a>&amp; inSharedPtr) :
<a name="l00052"></a>00052                 mpRep(inSharedPtr.mpRep), refcnt(inSharedPtr.refcnt)
<a name="l00053"></a>00053         {
<a name="l00054"></a>00054             <span class="keywordflow">if</span> (refcnt)
<a name="l00055"></a>00055             {
<a name="l00056"></a>00056                 refcnt-&gt;<a class="code" href="classOsclRefCounter.html#a36656788a3ab2b554bc7e917bf6a4adb">addRef</a>();
<a name="l00057"></a>00057             }
<a name="l00058"></a>00058         }
<a name="l00059"></a>00059 
<a name="l00060"></a>00060 
<a name="l00062"></a><a class="code" href="group__osclbase.html#ga6225904b5fa63a7379006e3f06c0b06a">00062</a>         <span class="keyword">virtual</span> <a class="code" href="group__osclbase.html#ga6225904b5fa63a7379006e3f06c0b06a" title="Destructor.">~OsclSharedPtr</a>()
<a name="l00063"></a>00063         {
<a name="l00064"></a>00064             <span class="keywordflow">if</span> (refcnt != <a class="code" href="group__osclbase.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4" title="The NULL_TERM_CHAR is used to terminate c-style strings.">NULL</a>)
<a name="l00065"></a>00065             {
<a name="l00066"></a>00066                 refcnt-&gt;<a class="code" href="classOsclRefCounter.html#aa7b138fd57f149a575356e51ee2d4451">removeRef</a>();
<a name="l00067"></a>00067             }
<a name="l00068"></a>00068         } <span class="comment">// end destructor</span>
<a name="l00069"></a>00069 
<a name="l00070"></a>00070 
<a name="l00073"></a><a class="code" href="group__osclbase.html#ga9172a5f5333a2f3cd5b0666e4ca8f7d6">00073</a>         TheClass* <a class="code" href="group__osclbase.html#ga9172a5f5333a2f3cd5b0666e4ca8f7d6">operator-&gt;</a>()
<a name="l00074"></a>00074         {
<a name="l00075"></a>00075             <span class="keywordflow">return</span> mpRep;
<a name="l00076"></a>00076         }
<a name="l00077"></a>00077 
<a name="l00079"></a><a class="code" href="group__osclbase.html#gae933e3a791eedeb012c163d749ed814d">00079</a>         TheClass&amp; <a class="code" href="group__osclbase.html#gae933e3a791eedeb012c163d749ed814d" title="The indirection operator returns a reference to an object of the parameterized type...">operator*</a>()
<a name="l00080"></a>00080         {
<a name="l00081"></a>00081             <span class="keywordflow">return</span> *mpRep;
<a name="l00082"></a>00082         }
<a name="l00083"></a>00083 
<a name="l00085"></a><a class="code" href="group__osclbase.html#ga15eac54f31b6df7fe5df004141ae7f43">00085</a>         <a class="code" href="group__osclbase.html#ga15eac54f31b6df7fe5df004141ae7f43" title="Casting operator.">operator TheClass*</a>()
<a name="l00086"></a>00086         {
<a name="l00087"></a>00087             <span class="keywordflow">return</span> mpRep;
<a name="l00088"></a>00088         }
<a name="l00089"></a>00089 
<a name="l00091"></a><a class="code" href="group__osclbase.html#ga16e5b2c74486acf9d5721e47dbeaa8d6">00091</a>         TheClass* <a class="code" href="group__osclbase.html#ga16e5b2c74486acf9d5721e47dbeaa8d6" title="Use this function to get a pointer to the wrapped object.">GetRep</a>()
<a name="l00092"></a>00092         {
<a name="l00093"></a>00093             <span class="keywordflow">return</span> mpRep;
<a name="l00094"></a>00094         }
<a name="l00095"></a>00095 
<a name="l00097"></a><a class="code" href="group__osclbase.html#ga8de7359219d8c3c7991b0207b88a119f">00097</a>         <a class="code" href="classOsclRefCounter.html">OsclRefCounter</a>* <a class="code" href="group__osclbase.html#ga8de7359219d8c3c7991b0207b88a119f" title="Get the refcount pointer. This should primarily be used for conversion operations...">GetRefCounter</a>()
<a name="l00098"></a>00098         {
<a name="l00099"></a>00099             <span class="keywordflow">return</span> refcnt;
<a name="l00100"></a>00100         }
<a name="l00101"></a>00101 
<a name="l00103"></a><a class="code" href="group__osclbase.html#gaa2a06a6f82c42db5f18491805937508b">00103</a>         <span class="keywordtype">int</span> <a class="code" href="group__osclbase.html#gaa2a06a6f82c42db5f18491805937508b" title="Get a count of how many references to the object exist.">get_count</a>()
<a name="l00104"></a>00104         {
<a name="l00105"></a>00105             <span class="keywordflow">return</span> (refcnt == <a class="code" href="group__osclbase.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4" title="The NULL_TERM_CHAR is used to terminate c-style strings.">NULL</a>) ? 0 : refcnt-&gt;<a class="code" href="classOsclRefCounter.html#a647a4b140b695ad7f8e68e41cb3cc137">getCount</a>();
<a name="l00106"></a>00106         }
<a name="l00107"></a>00107 
<a name="l00109"></a>00109         <span class="keywordtype">void</span> <a class="code" href="group__osclbase.html#ga1d0584bc00294d8a38ed327de540dbb9" title="Use this function to bind an existing OsclSharedPtr to a already-wrapped object.">Bind</a>(<span class="keyword">const</span> <a class="code" href="classOsclSharedPtr.html" title="A parameterized smart pointer class.">OsclSharedPtr</a>&amp; inHandle);
<a name="l00110"></a>00110 
<a name="l00112"></a>00112         <span class="keywordtype">void</span> <a class="code" href="group__osclbase.html#ga1d0584bc00294d8a38ed327de540dbb9" title="Use this function to bind an existing OsclSharedPtr to a already-wrapped object.">Bind</a>(TheClass* ptr, <a class="code" href="classOsclRefCounter.html">OsclRefCounter</a>* in_refcnt);
<a name="l00113"></a>00113 
<a name="l00115"></a><a class="code" href="group__osclbase.html#ga8aad65d5c763ed07ec379b4f080c1899">00115</a>         <span class="keywordtype">void</span> <a class="code" href="group__osclbase.html#ga8aad65d5c763ed07ec379b4f080c1899" title="Use this function of unbind an existing OsclSharedPtr.">Unbind</a>()
<a name="l00116"></a>00116         {
<a name="l00117"></a>00117             <a class="code" href="group__osclbase.html#ga1d0584bc00294d8a38ed327de540dbb9" title="Use this function to bind an existing OsclSharedPtr to a already-wrapped object.">Bind</a>(<a class="code" href="group__osclbase.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4" title="The NULL_TERM_CHAR is used to terminate c-style strings.">NULL</a>, <a class="code" href="group__osclbase.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4" title="The NULL_TERM_CHAR is used to terminate c-style strings.">NULL</a>);
<a name="l00118"></a>00118         };
<a name="l00119"></a>00119 
<a name="l00121"></a><a class="code" href="group__osclbase.html#ga10da41094264a26676f267f45a7e550a">00121</a>         <a class="code" href="classOsclSharedPtr.html" title="A parameterized smart pointer class.">OsclSharedPtr</a>&amp; <a class="code" href="group__osclbase.html#ga10da41094264a26676f267f45a7e550a" title="Assignment operator.">operator=</a>(<span class="keyword">const</span> <a class="code" href="classOsclSharedPtr.html" title="A parameterized smart pointer class.">OsclSharedPtr</a>&amp; inSharedPtr)
<a name="l00122"></a>00122         {
<a name="l00123"></a>00123             <a class="code" href="group__osclbase.html#ga1d0584bc00294d8a38ed327de540dbb9" title="Use this function to bind an existing OsclSharedPtr to a already-wrapped object.">Bind</a>(inSharedPtr);
<a name="l00124"></a>00124             <span class="keywordflow">return</span> *<span class="keyword">this</span>;
<a name="l00125"></a>00125         }
<a name="l00126"></a>00126 
<a name="l00128"></a>00128         <span class="keywordtype">bool</span> <a class="code" href="group__osclbase.html#ga948093bfeedab10a96d8fda172a85250" title="Test for equality to see if two PVHandles wrap the same object.">operator==</a>(<span class="keyword">const</span> <a class="code" href="classOsclSharedPtr.html" title="A parameterized smart pointer class.">OsclSharedPtr</a>&amp; b) <span class="keyword">const</span>;
<a name="l00129"></a>00129 
<a name="l00130"></a>00130     <span class="keyword">private</span>:
<a name="l00131"></a>00131 
<a name="l00132"></a>00132         TheClass* mpRep;
<a name="l00133"></a>00133         <a class="code" href="classOsclRefCounter.html">OsclRefCounter</a>* refcnt;
<a name="l00134"></a>00134 
<a name="l00135"></a>00135 };
<a name="l00136"></a>00136 
<a name="l00137"></a>00137 
<a name="l00138"></a><a class="code" href="group__osclbase.html#ga948093bfeedab10a96d8fda172a85250">00138</a> <span class="keyword">template</span> &lt;<span class="keyword">class</span> TheClass&gt; <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="group__osclbase.html#ga948093bfeedab10a96d8fda172a85250" title="Test for equality to see if two PVHandles wrap the same object.">OsclSharedPtr&lt;TheClass&gt;::operator==</a>(<span class="keyword">const</span> <a class="code" href="classOsclSharedPtr.html" title="A parameterized smart pointer class.">OsclSharedPtr&lt;TheClass&gt;</a>&amp; b)<span class="keyword"> const</span>
<a name="l00139"></a>00139 <span class="keyword"></span>{
<a name="l00140"></a>00140     <span class="keywordflow">if</span> ((this-&gt;mpRep == b.mpRep) &amp;&amp;
<a name="l00141"></a>00141             (this-&gt;refcnt == b.refcnt))
<a name="l00142"></a>00142     {
<a name="l00143"></a>00143         <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00144"></a>00144     }
<a name="l00145"></a>00145     <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00146"></a>00146 }
<a name="l00147"></a>00147 
<a name="l00148"></a>00148 
<a name="l00149"></a><a class="code" href="group__osclbase.html#ga1d0584bc00294d8a38ed327de540dbb9">00149</a> <span class="keyword">template</span> &lt;<span class="keyword">class</span> TheClass&gt; <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="group__osclbase.html#ga1d0584bc00294d8a38ed327de540dbb9" title="Use this function to bind an existing OsclSharedPtr to a already-wrapped object.">OsclSharedPtr&lt;TheClass&gt;::Bind</a>(<span class="keyword">const</span> <a class="code" href="classOsclSharedPtr.html" title="A parameterized smart pointer class.">OsclSharedPtr</a>&amp; inSharedPtr)
<a name="l00150"></a>00150 {
<a name="l00151"></a>00151     <span class="keywordflow">if</span> (mpRep == inSharedPtr.mpRep) <span class="keywordflow">return</span>;
<a name="l00152"></a>00152 
<a name="l00153"></a>00153     <span class="keywordflow">if</span> (refcnt != <a class="code" href="group__osclbase.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4" title="The NULL_TERM_CHAR is used to terminate c-style strings.">NULL</a>)
<a name="l00154"></a>00154     {
<a name="l00155"></a>00155         refcnt-&gt;<a class="code" href="classOsclRefCounter.html#aa7b138fd57f149a575356e51ee2d4451">removeRef</a>();
<a name="l00156"></a>00156     }
<a name="l00157"></a>00157 
<a name="l00158"></a>00158     refcnt = inSharedPtr.refcnt;
<a name="l00159"></a>00159     mpRep = inSharedPtr.mpRep;
<a name="l00160"></a>00160 
<a name="l00161"></a>00161     <span class="keywordflow">if</span> (refcnt != <a class="code" href="group__osclbase.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4" title="The NULL_TERM_CHAR is used to terminate c-style strings.">NULL</a>)
<a name="l00162"></a>00162     {
<a name="l00163"></a>00163         refcnt-&gt;<a class="code" href="classOsclRefCounter.html#a36656788a3ab2b554bc7e917bf6a4adb">addRef</a>();
<a name="l00164"></a>00164     }
<a name="l00165"></a>00165 
<a name="l00166"></a>00166 }
<a name="l00167"></a>00167 
<a name="l00168"></a><a class="code" href="group__osclbase.html#ga0f4eb250bf055b9f0b3210d99ae4c33f">00168</a> <span class="keyword">template</span> &lt;<span class="keyword">class</span> TheClass&gt; <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="group__osclbase.html#ga1d0584bc00294d8a38ed327de540dbb9" title="Use this function to bind an existing OsclSharedPtr to a already-wrapped object.">OsclSharedPtr&lt;TheClass&gt;::Bind</a>(TheClass* ptr,
<a name="l00169"></a>00169         <a class="code" href="classOsclRefCounter.html">OsclRefCounter</a>* in_refcnt)
<a name="l00170"></a>00170 {
<a name="l00171"></a>00171     <span class="keywordflow">if</span> (refcnt != <a class="code" href="group__osclbase.html#ga070d2ce7b6bb7e5c05602aa8c308d0c4" title="The NULL_TERM_CHAR is used to terminate c-style strings.">NULL</a>)
<a name="l00172"></a>00172     {
<a name="l00173"></a>00173         refcnt-&gt;<a class="code" href="classOsclRefCounter.html#aa7b138fd57f149a575356e51ee2d4451">removeRef</a>();
<a name="l00174"></a>00174     }
<a name="l00175"></a>00175 
<a name="l00176"></a>00176     mpRep = ptr;
<a name="l00177"></a>00177     refcnt = in_refcnt;
<a name="l00178"></a>00178 
<a name="l00179"></a>00179 }
<a name="l00180"></a>00180 
<a name="l00181"></a>00181 <span class="preprocessor">#endif  // OSCL_SHARED_PTR_H_INCLUDED</span>
</pre></div></div>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
<address style="align: left;"><small>Posting Version: CORE_9.004.1.1 </small>
</small></address>
</body>
</html>