doc/oscl_html/classOsclRefCounterMemFrag.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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288

<!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: OsclRefCounterMemFrag Class 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.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 class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>OsclRefCounterMemFrag Class Reference<br/>
<small>
[<a class="el" href="group__osclbase.html">OSCL Base</a>]</small>
</h1><!-- doxytag: class="OsclRefCounterMemFrag" -->
<p><code>#include &lt;<a class="el" href="oscl__refcounter__memfrag_8h_source.html">oscl_refcounter_memfrag.h</a>&gt;</code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclRefCounterMemFrag.html#aa475750c99b5daaf8dc600c2788e4f29">OsclRefCounterMemFrag</a> (<a class="el" href="structOsclMemoryFragment.html">OsclMemoryFragment</a> &amp;m, <a class="el" href="classOsclRefCounter.html">OsclRefCounter</a> *r, uint32 in_capacity)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclRefCounterMemFrag.html#af092328bb9f4f7e9a0f31fb70083d7cc">OsclRefCounterMemFrag</a> (const <a class="el" href="classOsclRefCounterMemFrag.html">OsclRefCounterMemFrag</a> &amp;x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclRefCounterMemFrag.html#a5af9dfeb79f994a1fe24c0886e4d47ea">OsclRefCounterMemFrag</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOsclRefCounterMemFrag.html">OsclRefCounterMemFrag</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclRefCounterMemFrag.html#a57472e3f083c9cd207e60535e9bacf3b">operator=</a> (const <a class="el" href="classOsclRefCounterMemFrag.html">OsclRefCounterMemFrag</a> &amp;x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclRefCounterMemFrag.html#ade700aa0752694cc80076de1510c65f9">~OsclRefCounterMemFrag</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOsclRefCounter.html">OsclRefCounter</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclRefCounterMemFrag.html#a4bb8d64ecbc6b2eaabd09325e353eeec">getRefCounter</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structOsclMemoryFragment.html">OsclMemoryFragment</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclRefCounterMemFrag.html#a91b285b6b4f4fc95e60523f69226efe0">getMemFrag</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__osclbase.html#ga3bac54662348f5e6c08b97ca97066b89">OsclAny</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclRefCounterMemFrag.html#ab7dce101b26f7cd7f64553efaacbadb3">getMemFragPtr</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclRefCounterMemFrag.html#ab1baab99d915ed52f5192da0c35d4ad1">getMemFragSize</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclRefCounterMemFrag.html#a36a2f6823ef9a01178621ea2d2dd9092">getCapacity</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclRefCounterMemFrag.html#a35d94ba86e29144522af28eae994f780">getCount</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Class to contain a memory fragment with it's associated reference counter. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aa475750c99b5daaf8dc600c2788e4f29"></a><!-- doxytag: member="OsclRefCounterMemFrag::OsclRefCounterMemFrag" ref="aa475750c99b5daaf8dc600c2788e4f29" args="(OsclMemoryFragment &amp;m, OsclRefCounter *r, uint32 in_capacity)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OsclRefCounterMemFrag::OsclRefCounterMemFrag </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structOsclMemoryFragment.html">OsclMemoryFragment</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>m</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classOsclRefCounter.html">OsclRefCounter</a> *&nbsp;</td>
          <td class="paramname"> <em>r</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32&nbsp;</td>
          <td class="paramname"> <em>in_capacity</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructor. A valid memory fragment and reference counter are required as input. The memory fragment structure will be copied locally.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>m</em>&nbsp;</td><td>reference to memory fragment </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>r</em>&nbsp;</td><td>pointer to the reference counter associated with the memory fragment. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="af092328bb9f4f7e9a0f31fb70083d7cc"></a><!-- doxytag: member="OsclRefCounterMemFrag::OsclRefCounterMemFrag" ref="af092328bb9f4f7e9a0f31fb70083d7cc" args="(const OsclRefCounterMemFrag &amp;x)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OsclRefCounterMemFrag::OsclRefCounterMemFrag </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classOsclRefCounterMemFrag.html">OsclRefCounterMemFrag</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>x</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Copy constructor. </p>

</div>
</div>
<a class="anchor" id="a5af9dfeb79f994a1fe24c0886e4d47ea"></a><!-- doxytag: member="OsclRefCounterMemFrag::OsclRefCounterMemFrag" ref="a5af9dfeb79f994a1fe24c0886e4d47ea" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OsclRefCounterMemFrag::OsclRefCounterMemFrag </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Default constructor. </p>

<p>References <a class="el" href="classOsclRefCounter.html#a36656788a3ab2b554bc7e917bf6a4adb">OsclRefCounter::addRef()</a>.</p>

</div>
</div>
<a class="anchor" id="ade700aa0752694cc80076de1510c65f9"></a><!-- doxytag: member="OsclRefCounterMemFrag::~OsclRefCounterMemFrag" ref="ade700aa0752694cc80076de1510c65f9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OsclRefCounterMemFrag::~OsclRefCounterMemFrag </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Destructor. Removes this object's reference from the reference counter. The reference counter will not be deleted. The reference counter is designed to self-delete when it's reference count reaches 0. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a36a2f6823ef9a01178621ea2d2dd9092"></a><!-- doxytag: member="OsclRefCounterMemFrag::getCapacity" ref="a36a2f6823ef9a01178621ea2d2dd9092" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32 OsclRefCounterMemFrag::getCapacity </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the capacity of the memory fragment</p>
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>

</div>
</div>
<a class="anchor" id="a35d94ba86e29144522af28eae994f780"></a><!-- doxytag: member="OsclRefCounterMemFrag::getCount" ref="a35d94ba86e29144522af28eae994f780" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32 OsclRefCounterMemFrag::getCount </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the reference counter's current count. </p>

</div>
</div>
<a class="anchor" id="a91b285b6b4f4fc95e60523f69226efe0"></a><!-- doxytag: member="OsclRefCounterMemFrag::getMemFrag" ref="a91b285b6b4f4fc95e60523f69226efe0" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structOsclMemoryFragment.html">OsclMemoryFragment</a>&amp; OsclRefCounterMemFrag::getMemFrag </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns a reference to the contained memory fragment structure. </p>

</div>
</div>
<a class="anchor" id="ab7dce101b26f7cd7f64553efaacbadb3"></a><!-- doxytag: member="OsclRefCounterMemFrag::getMemFragPtr" ref="ab7dce101b26f7cd7f64553efaacbadb3" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__osclbase.html#ga3bac54662348f5e6c08b97ca97066b89">OsclAny</a>* OsclRefCounterMemFrag::getMemFragPtr </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns a pointer to the memory fragment data. </p>

</div>
</div>
<a class="anchor" id="ab1baab99d915ed52f5192da0c35d4ad1"></a><!-- doxytag: member="OsclRefCounterMemFrag::getMemFragSize" ref="ab1baab99d915ed52f5192da0c35d4ad1" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32 OsclRefCounterMemFrag::getMemFragSize </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the size of the memory fragment data which equals its filled size.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd></dd></dl>

</div>
</div>
<a class="anchor" id="a4bb8d64ecbc6b2eaabd09325e353eeec"></a><!-- doxytag: member="OsclRefCounterMemFrag::getRefCounter" ref="a4bb8d64ecbc6b2eaabd09325e353eeec" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOsclRefCounter.html">OsclRefCounter</a>* OsclRefCounterMemFrag::getRefCounter </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns a pointer to the contained reference counter object </p>

</div>
</div>
<a class="anchor" id="a57472e3f083c9cd207e60535e9bacf3b"></a><!-- doxytag: member="OsclRefCounterMemFrag::operator=" ref="a57472e3f083c9cd207e60535e9bacf3b" args="(const OsclRefCounterMemFrag &amp;x)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOsclRefCounterMemFrag.html">OsclRefCounterMemFrag</a>&amp; OsclRefCounterMemFrag::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classOsclRefCounterMemFrag.html">OsclRefCounterMemFrag</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>x</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Assignment Operator </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="oscl__refcounter__memfrag_8h_source.html">oscl_refcounter_memfrag.h</a></li>
</ul>
</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.005.1.1 </small>
</small></address>
</body>
</html>