• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title> TemplateOsclSingleton&lt; T, ID, Registry &gt; class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5</head><body>
6<!-- Generated by Doxygen 1.2.18 -->
7<center>
8<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
9<hr><h1>OsclSingleton&lt; T, ID, Registry &gt; Class Template Reference</h1><code>#include &lt;<a class="el" href="oscl__singleton_8h-source.html">oscl_singleton.h</a>&gt;</code>
10<p>
11<table border=0 cellpadding=0 cellspacing=0>
12<tr><td></td></tr>
13<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
14<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classOsclSingleton.html#a0">OsclSingleton</a> ()</td></tr>
15<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classOsclSingleton.html#a1">~OsclSingleton</a> ()</td></tr>
16<tr><td nowrap align=right valign=top>T &amp;&nbsp;</td><td valign=bottom><a class="el" href="classOsclSingleton.html#a2">operator *</a> () const</td></tr>
17<tr><td>&nbsp;</td><td><font size=-1><em>The indirection operator (*) accesses a value indirectly, through a pointer.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
18<tr><td nowrap align=right valign=top>T *&nbsp;</td><td valign=bottom><a class="el" href="classOsclSingleton.html#a3">operator-&gt;</a> () const</td></tr>
19<tr><td>&nbsp;</td><td><font size=-1><em>The indirection operator (-&gt;) accesses a value indirectly, through a pointer.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
20<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classOsclSingleton.html#a4">set</a> ()</td></tr>
21<tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classOsclSingleton.html#a4">set()</a> method sets ownership to the pointer, passed. This method is needed when the class is created with a default constructor. Returns false in case the class is non-empty.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
22<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
23<tr><td nowrap align=right valign=top>T *&nbsp;</td><td valign=bottom><a class="el" href="classOsclSingleton.html#n0">_Ptr</a></td></tr>
24</table>
25<h3>template&lt;class T, uint32 ID, class Registry = OsclSingletonRegistry&gt;<br>
26 class OsclSingleton&lt; T, ID, Registry &gt;</h3>
27
28<hr><h2>Constructor &amp; Destructor Documentation</h2>
29<a name="a0" doxytag="OsclSingleton::OsclSingleton"></a><p>
30<table width="100%" cellpadding="2" cellspacing="0" border="0">
31  <tr>
32    <td class="md">
33      <table cellpadding="0" cellspacing="0" border="0">
34        <tr>
35          <td class="md" colspan="4">
36template&lt;class T, uint32 ID, class Registry = OsclSingletonRegistry&gt; </td>
37        </tr>
38        <tr>
39          <td class="md" nowrap valign="top"> OsclSingleton&lt; T, ID, Registry &gt;::OsclSingleton </td>
40          <td class="md" valign="top">(&nbsp;</td>
41          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
42          <td class="md" valign="top">)&nbsp;</td>
43          <td class="md" nowrap><code> [inline]</code></td>
44        </tr>
45
46      </table>
47    </td>
48  </tr>
49</table>
50<table cellspacing=5 cellpadding=0 border=0>
51  <tr>
52    <td>
53      &nbsp;
54    </td>
55    <td>
56
57<p>
58    </td>
59  </tr>
60</table>
61<a name="a1" doxytag="OsclSingleton::~OsclSingleton"></a><p>
62<table width="100%" cellpadding="2" cellspacing="0" border="0">
63  <tr>
64    <td class="md">
65      <table cellpadding="0" cellspacing="0" border="0">
66        <tr>
67          <td class="md" colspan="4">
68template&lt;class T, uint32 ID, class Registry = OsclSingletonRegistry&gt; </td>
69        </tr>
70        <tr>
71          <td class="md" nowrap valign="top"> OsclSingleton&lt; T, ID, Registry &gt;::~OsclSingleton </td>
72          <td class="md" valign="top">(&nbsp;</td>
73          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
74          <td class="md" valign="top">)&nbsp;</td>
75          <td class="md" nowrap><code> [inline]</code></td>
76        </tr>
77
78      </table>
79    </td>
80  </tr>
81</table>
82<table cellspacing=5 cellpadding=0 border=0>
83  <tr>
84    <td>
85      &nbsp;
86    </td>
87    <td>
88
89<p>
90    </td>
91  </tr>
92</table>
93<hr><h2>Member Function Documentation</h2>
94<a name="a2" doxytag="OsclSingleton::operator *"></a><p>
95<table width="100%" cellpadding="2" cellspacing="0" border="0">
96  <tr>
97    <td class="md">
98      <table cellpadding="0" cellspacing="0" border="0">
99        <tr>
100          <td class="md" colspan="4">
101template&lt;class T, uint32 ID, class Registry = OsclSingletonRegistry&gt; </td>
102        </tr>
103        <tr>
104          <td class="md" nowrap valign="top"> T&amp; OsclSingleton&lt; T, ID, Registry &gt;::operator * </td>
105          <td class="md" valign="top">(&nbsp;</td>
106          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
107          <td class="md" valign="top">)&nbsp;</td>
108          <td class="md" nowrap> const<code> [inline]</code></td>
109        </tr>
110
111      </table>
112    </td>
113  </tr>
114</table>
115<table cellspacing=5 cellpadding=0 border=0>
116  <tr>
117    <td>
118      &nbsp;
119    </td>
120    <td>
121
122<p>
123The indirection operator (*) accesses a value indirectly, through a pointer.
124<p>
125This operator ensures that the OsclSingleton can be used like the regular pointer that it was initialized with.     </td>
126  </tr>
127</table>
128<a name="a3" doxytag="OsclSingleton::operator->"></a><p>
129<table width="100%" cellpadding="2" cellspacing="0" border="0">
130  <tr>
131    <td class="md">
132      <table cellpadding="0" cellspacing="0" border="0">
133        <tr>
134          <td class="md" colspan="4">
135template&lt;class T, uint32 ID, class Registry = OsclSingletonRegistry&gt; </td>
136        </tr>
137        <tr>
138          <td class="md" nowrap valign="top"> T* OsclSingleton&lt; T, ID, Registry &gt;::operator-&gt; </td>
139          <td class="md" valign="top">(&nbsp;</td>
140          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
141          <td class="md" valign="top">)&nbsp;</td>
142          <td class="md" nowrap> const<code> [inline]</code></td>
143        </tr>
144
145      </table>
146    </td>
147  </tr>
148</table>
149<table cellspacing=5 cellpadding=0 border=0>
150  <tr>
151    <td>
152      &nbsp;
153    </td>
154    <td>
155
156<p>
157The indirection operator (-&gt;) accesses a value indirectly, through a pointer.
158<p>
159This operator ensures that the OsclSingleton can be used like the regular pointer that it was initialized with.     </td>
160  </tr>
161</table>
162<a name="a4" doxytag="OsclSingleton::set"></a><p>
163<table width="100%" cellpadding="2" cellspacing="0" border="0">
164  <tr>
165    <td class="md">
166      <table cellpadding="0" cellspacing="0" border="0">
167        <tr>
168          <td class="md" colspan="4">
169template&lt;class T, uint32 ID, class Registry = OsclSingletonRegistry&gt; </td>
170        </tr>
171        <tr>
172          <td class="md" nowrap valign="top"> bool OsclSingleton&lt; T, ID, Registry &gt;::set </td>
173          <td class="md" valign="top">(&nbsp;</td>
174          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
175          <td class="md" valign="top">)&nbsp;</td>
176          <td class="md" nowrap><code> [inline]</code></td>
177        </tr>
178
179      </table>
180    </td>
181  </tr>
182</table>
183<table cellspacing=5 cellpadding=0 border=0>
184  <tr>
185    <td>
186      &nbsp;
187    </td>
188    <td>
189
190<p>
191<a class="el" href="classOsclSingleton.html#a4">set()</a> method sets ownership to the pointer, passed. This method is needed when the class is created with a default constructor. Returns false in case the class is non-empty.
192<p>
193    </td>
194  </tr>
195</table>
196<hr><h2>Field Documentation</h2>
197<a name="n0" doxytag="OsclSingleton::_Ptr"></a><p>
198<table width="100%" cellpadding="2" cellspacing="0" border="0">
199  <tr>
200    <td class="md">
201      <table cellpadding="0" cellspacing="0" border="0">
202        <tr>
203          <td class="md" colspan="4">
204template&lt;class T, uint32 ID, class Registry = OsclSingletonRegistry&gt; </td>
205        </tr>
206        <tr>
207          <td class="md" nowrap valign="top"> T* OsclSingleton&lt; T, ID, Registry &gt;::_Ptr<code> [protected]</code>
208      </table>
209    </td>
210  </tr>
211</table>
212<table cellspacing=5 cellpadding=0 border=0>
213  <tr>
214    <td>
215      &nbsp;
216    </td>
217    <td>
218
219<p>
220    </td>
221  </tr>
222</table>
223<hr>The documentation for this class was generated from the following file:<ul>
224<li><a class="el" href="oscl__singleton_8h-source.html">oscl_singleton.h</a></ul>
225<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
226<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
227</small></address>
228</body>
229</html>
230