-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclassio_1_1_reader.html
More file actions
457 lines (423 loc) · 20.1 KB
/
classio_1_1_reader.html
File metadata and controls
457 lines (423 loc) · 20.1 KB
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OpenCK: io::Reader Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="openck48x48.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OpenCK
 <span id="projectnumber">0.0.alpha1</span>
</div>
<div id="projectbrief">An Open Source replacement for Bethesda's Creation Kit written in C++ in the Qt framework.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>io</b></li><li class="navelem"><a class="el" href="classio_1_1_reader.html">Reader</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> |
<a href="classio_1_1_reader-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">io::Reader Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Static class from which files are read.
<a href="classio_1_1_reader.html#details">More...</a></p>
<p><code>#include <<a class="el" href="reader_8h_source.html">reader.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9a9e4cf34beb243cd1d1323cbc08c433"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classio_1_1_reader.html#a9a9e4cf34beb243cd1d1323cbc08c433">Reader</a> (QDataStream *<a class="el" href="classio_1_1_reader.html#a67b1d81c2b8f096f9248ec215f3d028f">filestream</a>)</td></tr>
<tr class="memdesc:a9a9e4cf34beb243cd1d1323cbc08c433"><td class="mdescLeft"> </td><td class="mdescRight">Initialise a new reader object. <a href="#a9a9e4cf34beb243cd1d1323cbc08c433">More...</a><br /></td></tr>
<tr class="separator:a9a9e4cf34beb243cd1d1323cbc08c433"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f4dd423b146bfb91d7f5353ef1f3fcc"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:a4f4dd423b146bfb91d7f5353ef1f3fcc"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classio_1_1_reader.html#a4f4dd423b146bfb91d7f5353ef1f3fcc">read</a> ()</td></tr>
<tr class="memdesc:a4f4dd423b146bfb91d7f5353ef1f3fcc"><td class="mdescLeft"> </td><td class="mdescRight">Reads data from stream to any primitive type. <a href="#a4f4dd423b146bfb91d7f5353ef1f3fcc">More...</a><br /></td></tr>
<tr class="separator:a4f4dd423b146bfb91d7f5353ef1f3fcc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2d706d00b4243b60c12d1a47a6a4535d"><td class="memItemLeft" align="right" valign="top">quint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classio_1_1_reader.html#a2d706d00b4243b60c12d1a47a6a4535d">readType</a> ()</td></tr>
<tr class="memdesc:a2d706d00b4243b60c12d1a47a6a4535d"><td class="mdescLeft"> </td><td class="mdescRight">Read a type code from stream. <a href="#a2d706d00b4243b60c12d1a47a6a4535d">More...</a><br /></td></tr>
<tr class="separator:a2d706d00b4243b60c12d1a47a6a4535d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f99ee01672fbc3aa20481fffe483bbc"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classio_1_1_reader.html#a2f99ee01672fbc3aa20481fffe483bbc">readString</a> (quint32 size)</td></tr>
<tr class="memdesc:a2f99ee01672fbc3aa20481fffe483bbc"><td class="mdescLeft"> </td><td class="mdescRight">Read a string of known length. <a href="#a2f99ee01672fbc3aa20481fffe483bbc">More...</a><br /></td></tr>
<tr class="separator:a2f99ee01672fbc3aa20481fffe483bbc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4666495cde5225af6c529493bda46c2d"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classio_1_1_reader.html#a4666495cde5225af6c529493bda46c2d">readBstring</a> ()</td></tr>
<tr class="memdesc:a4666495cde5225af6c529493bda46c2d"><td class="mdescLeft"> </td><td class="mdescRight">Read a string of size specified in file stream. <a href="#a4666495cde5225af6c529493bda46c2d">More...</a><br /></td></tr>
<tr class="separator:a4666495cde5225af6c529493bda46c2d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae989653f2e963ea05eb532362a1f9ce8"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classio_1_1_reader.html#ae989653f2e963ea05eb532362a1f9ce8">readWstring</a> ()</td></tr>
<tr class="memdesc:ae989653f2e963ea05eb532362a1f9ce8"><td class="mdescLeft"> </td><td class="mdescRight">Read a string of size specified in file stream. <a href="#ae989653f2e963ea05eb532362a1f9ce8">More...</a><br /></td></tr>
<tr class="separator:ae989653f2e963ea05eb532362a1f9ce8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1ed03b93a34c52d8db068adf3ee73ad"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classio_1_1_reader.html#ad1ed03b93a34c52d8db068adf3ee73ad">readZstring</a> ()</td></tr>
<tr class="memdesc:ad1ed03b93a34c52d8db068adf3ee73ad"><td class="mdescLeft"> </td><td class="mdescRight">Read a zero-terminated string. <a href="#ad1ed03b93a34c52d8db068adf3ee73ad">More...</a><br /></td></tr>
<tr class="separator:ad1ed03b93a34c52d8db068adf3ee73ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2faecdd82dc3e3a8c646352ae019c66d"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classio_1_1_reader.html#a2faecdd82dc3e3a8c646352ae019c66d">lookupString</a> (QString filename, quint32 index, quint32 recordType, quint32 subrecord)</td></tr>
<tr class="memdesc:a2faecdd82dc3e3a8c646352ae019c66d"><td class="mdescLeft"> </td><td class="mdescRight">lookupString Look up and retrieve a localised string. <a href="#a2faecdd82dc3e3a8c646352ae019c66d">More...</a><br /></td></tr>
<tr class="separator:a2faecdd82dc3e3a8c646352ae019c66d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a67b1d81c2b8f096f9248ec215f3d028f"><td class="memItemLeft" align="right" valign="top">QDataStream * </td><td class="memItemRight" valign="bottom"><a class="el" href="classio_1_1_reader.html#a67b1d81c2b8f096f9248ec215f3d028f">filestream</a></td></tr>
<tr class="memdesc:a67b1d81c2b8f096f9248ec215f3d028f"><td class="mdescLeft"> </td><td class="mdescRight">filestream Pointer to the file stream. <a href="#a67b1d81c2b8f096f9248ec215f3d028f">More...</a><br /></td></tr>
<tr class="separator:a67b1d81c2b8f096f9248ec215f3d028f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0584e379be70f8ee07ad8045cdac6036"><td class="memItemLeft" align="right" valign="top">QByteArray </td><td class="memItemRight" valign="bottom"><a class="el" href="classio_1_1_reader.html#a0584e379be70f8ee07ad8045cdac6036">buffer</a></td></tr>
<tr class="memdesc:a0584e379be70f8ee07ad8045cdac6036"><td class="mdescLeft"> </td><td class="mdescRight">buffer Buffer to store data. <a href="#a0584e379be70f8ee07ad8045cdac6036">More...</a><br /></td></tr>
<tr class="separator:a0584e379be70f8ee07ad8045cdac6036"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Static class from which files are read. </p>
<p>Static class from which files are read. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a9a9e4cf34beb243cd1d1323cbc08c433"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a9e4cf34beb243cd1d1323cbc08c433">◆ </a></span>Reader()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">io::Reader::Reader </td>
<td>(</td>
<td class="paramtype">QDataStream * </td>
<td class="paramname"><em>filestream</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialise a new reader object. </p>
<p>Initialise a new reader object with a pointer to the file stream. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filestream</td><td>Pointer to the file stream. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2faecdd82dc3e3a8c646352ae019c66d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2faecdd82dc3e3a8c646352ae019c66d">◆ </a></span>lookupString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QString io::Reader::lookupString </td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">quint32 </td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">quint32 </td>
<td class="paramname"><em>recordType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">quint32 </td>
<td class="paramname"><em>subrecord</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>lookupString Look up and retrieve a localised string. </p>
<p>Look up and retrieve a localised string from strings file using an index. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>Name of streamed file. </td></tr>
<tr><td class="paramname">index</td><td>String ID. </td></tr>
<tr><td class="paramname">recordType</td><td>Type code of record requesting lookup. </td></tr>
<tr><td class="paramname">subrecord</td><td>Type code of subrecord requesting lookup. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>String. </dd></dl>
</div>
</div>
<a id="a4f4dd423b146bfb91d7f5353ef1f3fcc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f4dd423b146bfb91d7f5353ef1f3fcc">◆ </a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T io::Reader::read </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads data from stream to any primitive type. </p>
<p>Template function that reads from the file stream to any primitive type. </p><dl class="section return"><dt>Returns</dt><dd>Data to be read as a primitive type. </dd></dl>
</div>
</div>
<a id="a4666495cde5225af6c529493bda46c2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4666495cde5225af6c529493bda46c2d">◆ </a></span>readBstring()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QString io::Reader::readBstring </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read a string of size specified in file stream. </p>
<p>Read a string of size specified in file stream (byte). </p><dl class="section return"><dt>Returns</dt><dd>String. </dd></dl>
</div>
</div>
<a id="a2f99ee01672fbc3aa20481fffe483bbc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f99ee01672fbc3aa20481fffe483bbc">◆ </a></span>readString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QString io::Reader::readString </td>
<td>(</td>
<td class="paramtype">quint32 </td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read a string of known length. </p>
<p>Read a string of known length from the file stream. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>Length of string. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>String. </dd></dl>
</div>
</div>
<a id="a2d706d00b4243b60c12d1a47a6a4535d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d706d00b4243b60c12d1a47a6a4535d">◆ </a></span>readType()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">quint32 io::Reader::readType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read a type code from stream. </p>
<p>Read the type code of a record or subrecord header. </p><dl class="section return"><dt>Returns</dt><dd>Type code. </dd></dl>
</div>
</div>
<a id="ae989653f2e963ea05eb532362a1f9ce8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae989653f2e963ea05eb532362a1f9ce8">◆ </a></span>readWstring()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QString io::Reader::readWstring </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read a string of size specified in file stream. </p>
<p>Read a string of size specified in file stream (word/int16). </p><dl class="section return"><dt>Returns</dt><dd>String. </dd></dl>
</div>
</div>
<a id="ad1ed03b93a34c52d8db068adf3ee73ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1ed03b93a34c52d8db068adf3ee73ad">◆ </a></span>readZstring()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QString io::Reader::readZstring </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read a zero-terminated string. </p>
<p>Read a zero-terminated string from the file stream. </p><dl class="section return"><dt>Returns</dt><dd>String. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a0584e379be70f8ee07ad8045cdac6036"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0584e379be70f8ee07ad8045cdac6036">◆ </a></span>buffer</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QByteArray io::Reader::buffer</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>buffer Buffer to store data. </p>
<p>Buffer to store binary data temporarily. </p>
</div>
</div>
<a id="a67b1d81c2b8f096f9248ec215f3d028f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67b1d81c2b8f096f9248ec215f3d028f">◆ </a></span>filestream</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QDataStream* io::Reader::filestream</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>filestream Pointer to the file stream. </p>
<p>Pointer to the file stream. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="reader_8h_source.html">reader.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 14 2018 18:39:58 for OpenCK by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>