aboutsummaryrefslogtreecommitdiff
path: root/doc/oscl_html/classOsclTLSEx.html
blob: b1f980c73ae363311924d3bf1b3c805ceb2baad2 (plain)
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
<!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: OsclTLSEx&lt; T, ID, Registry &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>OsclTLSEx&lt; T, ID, Registry &gt; Class Template Reference<br/>
<small>
[<a class="el" href="group__osclerror.html">OSCL Error</a>]</small>
</h1><!-- doxytag: class="OsclTLSEx" -->
<p><code>#include &lt;<a class="el" href="oscl__error_8h_source.html">oscl_error.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="classOsclTLSEx.html#ae21a0aca64c4d1ac525b14fbd94d0856">OsclTLSEx</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclTLSEx.html#a0f04a6a82261d5087851e2e2e1dabe41">~OsclTLSEx</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclTLSEx.html#a1511d62ed7d57a020d4b45f820c6771f">operator*</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The indirection operator (*) accesses a value indirectly, through a pointer.  <a href="#a1511d62ed7d57a020d4b45f820c6771f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclTLSEx.html#afd6a6f549d8b0b8bb813e02910d48383">operator-&gt;</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The indirection operator (-&gt;) accesses a value indirectly, through a pointer.  <a href="#afd6a6f549d8b0b8bb813e02910d48383"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclTLSEx.html#ac45cbbc9ac06d533c77f71cccbdafb12">set</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classOsclTLSEx.html#ac45cbbc9ac06d533c77f71cccbdafb12" title="set() method sets ownership to the pointer, passed. This method is needed when the...">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.  <a href="#ac45cbbc9ac06d533c77f71cccbdafb12"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclTLSEx.html#a934f6a221a789268257b02d1056f5b68">_Ptr</a></td></tr>
</table>
<h3>template&lt;class T, uint32 ID, class Registry = OsclTLSRegistryEx&gt;<br/>
 class OsclTLSEx&lt; T, ID, Registry &gt;</h3>

<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ae21a0aca64c4d1ac525b14fbd94d0856"></a><!-- doxytag: member="OsclTLSEx::OsclTLSEx" ref="ae21a0aca64c4d1ac525b14fbd94d0856" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , uint32 ID, class Registry  = OsclTLSRegistryEx&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOsclTLSEx.html">OsclTLSEx</a>&lt; T, ID, Registry &gt;::<a class="el" href="classOsclTLSEx.html">OsclTLSEx</a> </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a0f04a6a82261d5087851e2e2e1dabe41"></a><!-- doxytag: member="OsclTLSEx::~OsclTLSEx" ref="a0f04a6a82261d5087851e2e2e1dabe41" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , uint32 ID, class Registry  = OsclTLSRegistryEx&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOsclTLSEx.html">OsclTLSEx</a>&lt; T, ID, Registry &gt;::~<a class="el" href="classOsclTLSEx.html">OsclTLSEx</a> </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1511d62ed7d57a020d4b45f820c6771f"></a><!-- doxytag: member="OsclTLSEx::operator*" ref="a1511d62ed7d57a020d4b45f820c6771f" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , uint32 ID, class Registry  = OsclTLSRegistryEx&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">T&amp; <a class="el" href="classOsclTLSEx.html">OsclTLSEx</a>&lt; T, ID, Registry &gt;::operator* </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The indirection operator (*) accesses a value indirectly, through a pointer. </p>
<p>This operator ensures that the <a class="el" href="classOsclTLS.html">OsclTLS</a> can be used like the regular pointer that it was initialized with. </p>

<p>References <a class="el" href="oscl__error_8h_source.html#l00336">OsclTLSEx&lt; T, ID, Registry &gt;::_Ptr</a>.</p>

</div>
</div>
<a class="anchor" id="afd6a6f549d8b0b8bb813e02910d48383"></a><!-- doxytag: member="OsclTLSEx::operator&#45;&gt;" ref="afd6a6f549d8b0b8bb813e02910d48383" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , uint32 ID, class Registry  = OsclTLSRegistryEx&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">T* <a class="el" href="classOsclTLSEx.html">OsclTLSEx</a>&lt; T, ID, Registry &gt;::operator-&gt; </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The indirection operator (-&gt;) accesses a value indirectly, through a pointer. </p>
<p>This operator ensures that the <a class="el" href="classOsclTLS.html">OsclTLS</a> can be used like the regular pointer that it was initialized with. </p>

<p>References <a class="el" href="oscl__error_8h_source.html#l00336">OsclTLSEx&lt; T, ID, Registry &gt;::_Ptr</a>.</p>

</div>
</div>
<a class="anchor" id="ac45cbbc9ac06d533c77f71cccbdafb12"></a><!-- doxytag: member="OsclTLSEx::set" ref="ac45cbbc9ac06d533c77f71cccbdafb12" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , uint32 ID, class Registry  = OsclTLSRegistryEx&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classOsclTLSEx.html">OsclTLSEx</a>&lt; T, ID, Registry &gt;::set </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p><a class="el" href="classOsclTLSEx.html#ac45cbbc9ac06d533c77f71cccbdafb12" title="set() method sets ownership to the pointer, passed. This method is needed when the...">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. </p>

<p>References <a class="el" href="oscl__error_8h_source.html#l00336">OsclTLSEx&lt; T, ID, Registry &gt;::_Ptr</a>, and <a class="el" href="oscl__base__macros_8h_source.html#l00065">OSCL_STATIC_CAST</a>.</p>

</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a934f6a221a789268257b02d1056f5b68"></a><!-- doxytag: member="OsclTLSEx::_Ptr" ref="a934f6a221a789268257b02d1056f5b68" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , uint32 ID, class Registry  = OsclTLSRegistryEx&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">T* <a class="el" href="classOsclTLSEx.html">OsclTLSEx</a>&lt; T, ID, Registry &gt;::<a class="el" href="classOsclTLSEx.html#a934f6a221a789268257b02d1056f5b68">_Ptr</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Referenced by <a class="el" href="oscl__error_8h_source.html#l00350">OsclTLSEx&lt; T, ID, Registry &gt;::operator*()</a>, <a class="el" href="oscl__error_8h_source.html#l00362">OsclTLSEx&lt; T, ID, Registry &gt;::operator-&gt;()</a>, and <a class="el" href="oscl__error_8h_source.html#l00374">OsclTLSEx&lt; T, ID, Registry &gt;::set()</a>.</p>

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