doc/oscl_html/classOsclSharedPtr.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

<!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: OsclSharedPtr&lt; TheClass &gt; 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.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>OsclSharedPtr&lt; TheClass &gt; Class Template Reference<br/>
<small>
[<a class="el" href="group__osclbase.html">OSCL Base</a>]</small>
</h1><!-- doxytag: class="OsclSharedPtr" -->
<p>A parameterized smart pointer class.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="oscl__shared__ptr_8h_source.html">oscl_shared_ptr.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="classOsclSharedPtr.html#ae25920e397d7a7f38fd2d06432cc22f2">OsclSharedPtr</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#ae25920e397d7a7f38fd2d06432cc22f2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclbase.html#gade51c7acffa07b9f8ba607b6d612e97c">OsclSharedPtr</a> (TheClass *inClassPtr, <a class="el" href="classOsclRefCounter.html">OsclRefCounter</a> *in_refcnt)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="group__osclbase.html#gade51c7acffa07b9f8ba607b6d612e97c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclbase.html#gab8cdae055fa3ab08039b0e022753b0d6">OsclSharedPtr</a> (const <a class="el" href="classOsclSharedPtr.html">OsclSharedPtr</a> &amp;inSharedPtr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor.  <a href="group__osclbase.html#gab8cdae055fa3ab08039b0e022753b0d6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclbase.html#ga6225904b5fa63a7379006e3f06c0b06a">~OsclSharedPtr</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor.  <a href="group__osclbase.html#ga6225904b5fa63a7379006e3f06c0b06a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TheClass *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclbase.html#ga9172a5f5333a2f3cd5b0666e4ca8f7d6">operator-&gt;</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TheClass &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclbase.html#gae933e3a791eedeb012c163d749ed814d">operator*</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The indirection operator returns a reference to an object of the parameterized type.  <a href="group__osclbase.html#gae933e3a791eedeb012c163d749ed814d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclbase.html#ga15eac54f31b6df7fe5df004141ae7f43">operator TheClass *</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Casting operator.  <a href="group__osclbase.html#ga15eac54f31b6df7fe5df004141ae7f43"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TheClass *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclbase.html#ga16e5b2c74486acf9d5721e47dbeaa8d6">GetRep</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Use this function to get a pointer to the wrapped object.  <a href="group__osclbase.html#ga16e5b2c74486acf9d5721e47dbeaa8d6"></a><br/></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="group__osclbase.html#ga8de7359219d8c3c7991b0207b88a119f">GetRefCounter</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the refcount pointer. This should primarily be used for conversion operations.  <a href="group__osclbase.html#ga8de7359219d8c3c7991b0207b88a119f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclbase.html#gaa2a06a6f82c42db5f18491805937508b">get_count</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a count of how many references to the object exist.  <a href="group__osclbase.html#gaa2a06a6f82c42db5f18491805937508b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclbase.html#ga1d0584bc00294d8a38ed327de540dbb9">Bind</a> (const <a class="el" href="classOsclSharedPtr.html">OsclSharedPtr</a> &amp;inHandle)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Use this function to bind an existing <a class="el" href="classOsclSharedPtr.html" title="A parameterized smart pointer class.">OsclSharedPtr</a> to a already-wrapped object.  <a href="group__osclbase.html#ga1d0584bc00294d8a38ed327de540dbb9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclbase.html#ga0f4eb250bf055b9f0b3210d99ae4c33f">Bind</a> (TheClass *ptr, <a class="el" href="classOsclRefCounter.html">OsclRefCounter</a> *in_refcnt)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Use this function to bind an existing <a class="el" href="classOsclSharedPtr.html" title="A parameterized smart pointer class.">OsclSharedPtr</a> to a new (unwrapped) object.  <a href="group__osclbase.html#ga0f4eb250bf055b9f0b3210d99ae4c33f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclbase.html#ga8aad65d5c763ed07ec379b4f080c1899">Unbind</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Use this function of unbind an existing <a class="el" href="classOsclSharedPtr.html" title="A parameterized smart pointer class.">OsclSharedPtr</a>.  <a href="group__osclbase.html#ga8aad65d5c763ed07ec379b4f080c1899"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOsclSharedPtr.html">OsclSharedPtr</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclbase.html#ga10da41094264a26676f267f45a7e550a">operator=</a> (const <a class="el" href="classOsclSharedPtr.html">OsclSharedPtr</a> &amp;inSharedPtr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assignment operator.  <a href="group__osclbase.html#ga10da41094264a26676f267f45a7e550a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclbase.html#ga948093bfeedab10a96d8fda172a85250">operator==</a> (const <a class="el" href="classOsclSharedPtr.html">OsclSharedPtr</a> &amp;b) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Test for equality to see if two PVHandles wrap the same object.  <a href="group__osclbase.html#ga948093bfeedab10a96d8fda172a85250"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class TheClass&gt;<br/>
 class OsclSharedPtr&lt; TheClass &gt;</h3>

<p>A parameterized smart pointer class. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ae25920e397d7a7f38fd2d06432cc22f2"></a><!-- doxytag: member="OsclSharedPtr::OsclSharedPtr" ref="ae25920e397d7a7f38fd2d06432cc22f2" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TheClass&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOsclSharedPtr.html">OsclSharedPtr</a>&lt; TheClass &gt;::<a class="el" href="classOsclSharedPtr.html">OsclSharedPtr</a> </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Constructor. </p>

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