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
289
290
291
292
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxDefaultFileInputData Class Reference</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css">
</head>
<body bgcolor="#FFFFFF">
<div id="header">
<hr class="first">
<img alt="" src="images/PhysXlogo.png" align="middle"> <br>
<center>
<a class="qindex" href="main.html">Main Page</a>
<a class="qindex" href="hierarchy.html">Class Hierarchy</a>
<a class="qindex" href="annotated.html">Compound List</a>
<a class="qindex" href="functions.html">Compound Members</a>
</center>
<hr class="second">
</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="contents">
<h1>PxDefaultFileInputData Class Reference<br>
<small>
[<a class="el" href="group__extensions.html">Extensions</a>]</small>
</h1><!-- doxytag: class="PxDefaultFileInputData" --><!-- doxytag: inherits="PxInputData" -->default implementation of a file read stream
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxDefaultStreams_8h-source.html">PxDefaultStreams.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for PxDefaultFileInputData:</div>
<div class="dynsection">
<p><center><img src="classPxDefaultFileInputData__inherit__graph.png" border="0" usemap="#PxDefaultFileInputData__inherit__map" alt="Inheritance graph"></center>
<map name="PxDefaultFileInputData__inherit__map">
<area shape="rect" href="classPxInputData.html" title="Input data class for I/O which provides random read access." alt="PxInputData" coords="37,85,117,106"><area shape="rect" href="classPxInputStream.html" title="Input stream class for I/O." alt="PxInputStream" coords="31,16,124,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for PxDefaultFileInputData:</div>
<div class="dynsection">
<p><center><img src="classPxDefaultFileInputData__coll__graph.png" border="0" usemap="#PxDefaultFileInputData__coll__map" alt="Collaboration graph"></center>
<map name="PxDefaultFileInputData__coll__map">
<area shape="rect" href="classPxInputData.html" title="Input data class for I/O which provides random read access." alt="PxInputData" coords="37,85,117,106"><area shape="rect" href="classPxInputStream.html" title="Input stream class for I/O." alt="PxInputStream" coords="31,16,124,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classPxDefaultFileInputData-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultFileInputData.html#2c88c3e9ccea05b57cef38fcba31e574">PxDefaultFileInputData</a> (const char *name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultFileInputData.html#3c0fe6915616be24441f12e821901cbc">~PxDefaultFileInputData</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultFileInputData.html#53cec0da0055e7a996c6d85dd9ab427b">read</a> (void *dest, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">read from the stream. The number of bytes read may be less than the number requested. <a href="#53cec0da0055e7a996c6d85dd9ab427b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultFileInputData.html#234ab504e8d281b6e0319e40dcac7c4d">seek</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> pos)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">seek to the given offset from the start of the data. <a href="#234ab504e8d281b6e0319e40dcac7c4d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultFileInputData.html#d2f00723bda0098239c4b8201c6812d3">tell</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the current offset from the start of the data <a href="#d2f00723bda0098239c4b8201c6812d3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultFileInputData.html#a62b6c699d8f741f52e105a44a5ffe2a">getLength</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the length of the input data <a href="#a62b6c699d8f741f52e105a44a5ffe2a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultFileInputData.html#c97fd1862408d5abd905e087f1221ab3">isValid</a> () const </td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__extensions.html#g8e55355887d57086f097b0248b7ea768">PxFileHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultFileInputData.html#d95719a03dfc71fef8cfa08264955303">mFile</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxDefaultFileInputData.html#951d2109fe99dc5339321d21e6efae11">mLength</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
default implementation of a file read stream
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxInputData.html" title="Input data class for I/O which provides random read access.">PxInputData</a> </dd></dl>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="2c88c3e9ccea05b57cef38fcba31e574"></a><!-- doxytag: member="PxDefaultFileInputData::PxDefaultFileInputData" ref="2c88c3e9ccea05b57cef38fcba31e574" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxDefaultFileInputData::PxDefaultFileInputData </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="3c0fe6915616be24441f12e821901cbc"></a><!-- doxytag: member="PxDefaultFileInputData::~PxDefaultFileInputData" ref="3c0fe6915616be24441f12e821901cbc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxDefaultFileInputData::~PxDefaultFileInputData </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a62b6c699d8f741f52e105a44a5ffe2a"></a><!-- doxytag: member="PxDefaultFileInputData::getLength" ref="a62b6c699d8f741f52e105a44a5ffe2a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxDefaultFileInputData::getLength </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
return the length of the input data
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>size in bytes of the input data </dd></dl>
<p>Implements <a class="el" href="classPxInputData.html#bab049ab736da6c5880426f3d977698b">PxInputData</a>.</p>
</div>
</div><p>
<a class="anchor" name="c97fd1862408d5abd905e087f1221ab3"></a><!-- doxytag: member="PxDefaultFileInputData::isValid" ref="c97fd1862408d5abd905e087f1221ab3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool PxDefaultFileInputData::isValid </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="53cec0da0055e7a996c6d85dd9ab427b"></a><!-- doxytag: member="PxDefaultFileInputData::read" ref="53cec0da0055e7a996c6d85dd9ab427b" args="(void *dest, PxU32 count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxDefaultFileInputData::read </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
read from the stream. The number of bytes read may be less than the number requested.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>dest</em> </td><td>the destination address to which the data will be read </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>count</em> </td><td>the number of bytes requested</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of bytes read from the stream. </dd></dl>
<p>Implements <a class="el" href="classPxInputStream.html#74fdc1e5af87577e7cc13cc99894b2b3">PxInputStream</a>.</p>
</div>
</div><p>
<a class="anchor" name="234ab504e8d281b6e0319e40dcac7c4d"></a><!-- doxytag: member="PxDefaultFileInputData::seek" ref="234ab504e8d281b6e0319e40dcac7c4d" args="(PxU32 pos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void PxDefaultFileInputData::seek </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td>
<td class="paramname"> <em>offset</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
seek to the given offset from the start of the data.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>offset</em> </td><td>the offset to seek to. If greater than the length of the data, this call is equivalent to seek(length); </td></tr>
</table>
</dl>
<p>Implements <a class="el" href="classPxInputData.html#c80d55021a6bae02a1cc64d27a98c575">PxInputData</a>.</p>
</div>
</div><p>
<a class="anchor" name="d2f00723bda0098239c4b8201c6812d3"></a><!-- doxytag: member="PxDefaultFileInputData::tell" ref="d2f00723bda0098239c4b8201c6812d3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxDefaultFileInputData::tell </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
return the current offset from the start of the data
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the offset to seek to. </dd></dl>
<p>Implements <a class="el" href="classPxInputData.html#5ce54bcfb43ca0e9dd22bf15fcf75cab">PxInputData</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="d95719a03dfc71fef8cfa08264955303"></a><!-- doxytag: member="PxDefaultFileInputData::mFile" ref="d95719a03dfc71fef8cfa08264955303" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__extensions.html#g8e55355887d57086f097b0248b7ea768">PxFileHandle</a> <a class="el" href="classPxDefaultFileInputData.html#d95719a03dfc71fef8cfa08264955303">PxDefaultFileInputData::mFile</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="951d2109fe99dc5339321d21e6efae11"></a><!-- doxytag: member="PxDefaultFileInputData::mLength" ref="951d2109fe99dc5339321d21e6efae11" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxDefaultFileInputData.html#951d2109fe99dc5339321d21e6efae11">PxDefaultFileInputData::mLength</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxDefaultStreams_8h-source.html">PxDefaultStreams.h</a></ul>
</div>
<hr style="width: 100%; height: 2px;"><br>
Copyright © 2008-2018 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a>
</body>
</html>
|