-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclassChunkFile.html
488 lines (443 loc) · 27 KB
/
classChunkFile.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
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
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>3D Forest: ChunkFile Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript">var page_layout=1;</script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="side-nav" class="ui-resizable side-nav-resizable"><!-- do not remove this div, it is closed by doxygen! -->
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">3D Forest
</div>
<div id="projectbrief">Software for analysis of Lidar data from forest environment.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
</div><!-- top -->
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('classChunkFile.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-methods">Private Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> |
<a href="classChunkFile-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ChunkFile Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include <ChunkFile.hpp></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structChunkFile_1_1Chunk.html">Chunk</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acc303ad6a35ccdc5eae401da257881de" id="r_acc303ad6a35ccdc5eae401da257881de"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#acc303ad6a35ccdc5eae401da257881de">ChunkFile</a> ()</td></tr>
<tr class="separator:acc303ad6a35ccdc5eae401da257881de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd9ed9b3e3f2bc98beed36fdfcc41a24" id="r_acd9ed9b3e3f2bc98beed36fdfcc41a24"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#acd9ed9b3e3f2bc98beed36fdfcc41a24">~ChunkFile</a> ()</td></tr>
<tr class="separator:acd9ed9b3e3f2bc98beed36fdfcc41a24"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b6eb95120bf70cce3cd2a7e3d9f2d0d" id="r_a7b6eb95120bf70cce3cd2a7e3d9f2d0d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7b6eb95120bf70cce3cd2a7e3d9f2d0d">open</a> (const std::string &<a class="el" href="#ab4cd56eb32c3afb330c5d218395d8122">path</a>, const std::string &mode)</td></tr>
<tr class="separator:a7b6eb95120bf70cce3cd2a7e3d9f2d0d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acbc09a8ef4b3e3dadeb554dfb34eaaa0" id="r_acbc09a8ef4b3e3dadeb554dfb34eaaa0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#acbc09a8ef4b3e3dadeb554dfb34eaaa0">close</a> ()</td></tr>
<tr class="separator:acbc09a8ef4b3e3dadeb554dfb34eaaa0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5202b2b99ac9426ebfe8f310648f30d2" id="r_a5202b2b99ac9426ebfe8f310648f30d2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5202b2b99ac9426ebfe8f310648f30d2">seek</a> (uint64_t <a class="el" href="#ad7be485e45b63454038675095e025418">offset</a>)</td></tr>
<tr class="separator:a5202b2b99ac9426ebfe8f310648f30d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac9c3bd08c61121710290ca967865e3a8" id="r_ac9c3bd08c61121710290ca967865e3a8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac9c3bd08c61121710290ca967865e3a8">skip</a> (uint64_t nbyte)</td></tr>
<tr class="separator:ac9c3bd08c61121710290ca967865e3a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9934f1a975b3e30fc194503dc15731c4" id="r_a9934f1a975b3e30fc194503dc15731c4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9934f1a975b3e30fc194503dc15731c4">read</a> (<a class="el" href="structChunkFile_1_1Chunk.html">Chunk</a> &chunk)</td></tr>
<tr class="separator:a9934f1a975b3e30fc194503dc15731c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a20b0a7cb9846509db14525b3221cdd3c" id="r_a20b0a7cb9846509db14525b3221cdd3c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a20b0a7cb9846509db14525b3221cdd3c">read</a> (uint8_t *buffer, uint64_t nbyte)</td></tr>
<tr class="separator:a20b0a7cb9846509db14525b3221cdd3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa760b32f0e8bf05b90e9e2a72a7ada26" id="r_aa760b32f0e8bf05b90e9e2a72a7ada26"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa760b32f0e8bf05b90e9e2a72a7ada26">write</a> (const <a class="el" href="structChunkFile_1_1Chunk.html">Chunk</a> &chunk)</td></tr>
<tr class="separator:aa760b32f0e8bf05b90e9e2a72a7ada26"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af5b13c13d369e2e3e42d4e88b6e8d096" id="r_af5b13c13d369e2e3e42d4e88b6e8d096"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#af5b13c13d369e2e3e42d4e88b6e8d096">write</a> (const uint8_t *buffer, uint64_t nbyte)</td></tr>
<tr class="separator:af5b13c13d369e2e3e42d4e88b6e8d096"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f1b4b91acd806bfb1a5ef1f208e3035" id="r_a9f1b4b91acd806bfb1a5ef1f208e3035"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9f1b4b91acd806bfb1a5ef1f208e3035">validate</a> (const <a class="el" href="structChunkFile_1_1Chunk.html">Chunk</a> &chunk, uint32_t type, uint8_t majorVersion, uint8_t minorVersion) const</td></tr>
<tr class="separator:a9f1b4b91acd806bfb1a5ef1f208e3035"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2fb378195a073690a52256cf641d7f36" id="r_a2fb378195a073690a52256cf641d7f36"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2fb378195a073690a52256cf641d7f36">eof</a> () const</td></tr>
<tr class="separator:a2fb378195a073690a52256cf641d7f36"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6a4ea3bafc07302501a2f2fefcd56ba" id="r_ab6a4ea3bafc07302501a2f2fefcd56ba"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab6a4ea3bafc07302501a2f2fefcd56ba">size</a> () const</td></tr>
<tr class="separator:ab6a4ea3bafc07302501a2f2fefcd56ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7be485e45b63454038675095e025418" id="r_ad7be485e45b63454038675095e025418"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad7be485e45b63454038675095e025418">offset</a> () const</td></tr>
<tr class="separator:ad7be485e45b63454038675095e025418"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab4cd56eb32c3afb330c5d218395d8122" id="r_ab4cd56eb32c3afb330c5d218395d8122"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab4cd56eb32c3afb330c5d218395d8122">path</a> () const</td></tr>
<tr class="separator:ab4cd56eb32c3afb330c5d218395d8122"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a2eaf343a0aea445734fc42800590f5e3" id="r_a2eaf343a0aea445734fc42800590f5e3"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2eaf343a0aea445734fc42800590f5e3">status</a> () const</td></tr>
<tr class="separator:a2eaf343a0aea445734fc42800590f5e3"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:aeb986e42b8f608d030a86d0a60e529c3" id="r_aeb986e42b8f608d030a86d0a60e529c3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classFile.html">File</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aeb986e42b8f608d030a86d0a60e529c3">file_</a></td></tr>
<tr class="separator:aeb986e42b8f608d030a86d0a60e529c3"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Simplified PNG/IFF like binary file format. It contains series of chunks. The first chunk type provides file signature. Each chunk contains both metadata (header) and data. <a class="el" href="structChunkFile_1_1Chunk.html" title="Chunk Header.">Chunk</a> bytes are { sizeof(Chunk), headerLength, dataLength }. The maximum length of chunk data is 64-bit value (16 exabytes). All multi-byte integers are in little-endian format. All integers should be aligned to file offsets by their size. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="acc303ad6a35ccdc5eae401da257881de" name="acc303ad6a35ccdc5eae401da257881de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc303ad6a35ccdc5eae401da257881de">◆ </a></span>ChunkFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ChunkFile::ChunkFile </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acd9ed9b3e3f2bc98beed36fdfcc41a24" name="acd9ed9b3e3f2bc98beed36fdfcc41a24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd9ed9b3e3f2bc98beed36fdfcc41a24">◆ </a></span>~ChunkFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ChunkFile::~ChunkFile </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="acbc09a8ef4b3e3dadeb554dfb34eaaa0" name="acbc09a8ef4b3e3dadeb554dfb34eaaa0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbc09a8ef4b3e3dadeb554dfb34eaaa0">◆ </a></span>close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ChunkFile::close </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">Referenced by <a class="el" href="classIndexFile.html#aa69251e88e3921905213e883a394688e">IndexFile::read()</a>, <a class="el" href="classIndexFile.html#a847713c31e01d4e2b3ee3966ee0d174e">IndexFile::read()</a>, <a class="el" href="classIndexFileBuilder.html#ad96867f425717a02661e47cd199043d9">IndexFileBuilder::stateNodeEnd()</a>, and <a class="el" href="classIndexFile.html#ab868d93812dccb43b8ae4602c8024635">IndexFile::write()</a>.</p>
</div>
</div>
<a id="a2fb378195a073690a52256cf641d7f36" name="a2fb378195a073690a52256cf641d7f36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2fb378195a073690a52256cf641d7f36">◆ </a></span>eof()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ChunkFile::eof </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad7be485e45b63454038675095e025418" name="ad7be485e45b63454038675095e025418"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7be485e45b63454038675095e025418">◆ </a></span>offset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t ChunkFile::offset </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">Referenced by <a class="el" href="#a5202b2b99ac9426ebfe8f310648f30d2">seek()</a>, <a class="el" href="classIndexFileBuilder.html#aa2f10cf0750d736387b1287fa44b83e2">IndexFileBuilder::stateNodeInsert()</a>, and <a class="el" href="#a2eaf343a0aea445734fc42800590f5e3">status()</a>.</p>
</div>
</div>
<a id="a7b6eb95120bf70cce3cd2a7e3d9f2d0d" name="a7b6eb95120bf70cce3cd2a7e3d9f2d0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b6eb95120bf70cce3cd2a7e3d9f2d0d">◆ </a></span>open()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ChunkFile::open </td>
<td>(</td>
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>mode</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">Referenced by <a class="el" href="classIndexFile.html#aa69251e88e3921905213e883a394688e">IndexFile::read()</a>, <a class="el" href="classIndexFile.html#a847713c31e01d4e2b3ee3966ee0d174e">IndexFile::read()</a>, <a class="el" href="classIndexFileBuilder.html#aa1545ac1bf9d9ef8cd3cb3a4c1888469">IndexFileBuilder::stateMainEnd()</a>, and <a class="el" href="classIndexFile.html#ab868d93812dccb43b8ae4602c8024635">IndexFile::write()</a>.</p>
</div>
</div>
<a id="ab4cd56eb32c3afb330c5d218395d8122" name="ab4cd56eb32c3afb330c5d218395d8122"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4cd56eb32c3afb330c5d218395d8122">◆ </a></span>path()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string & ChunkFile::path </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">Referenced by <a class="el" href="#a7b6eb95120bf70cce3cd2a7e3d9f2d0d">open()</a>, and <a class="el" href="#a2eaf343a0aea445734fc42800590f5e3">status()</a>.</p>
</div>
</div>
<a id="a9934f1a975b3e30fc194503dc15731c4" name="a9934f1a975b3e30fc194503dc15731c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9934f1a975b3e30fc194503dc15731c4">◆ </a></span>read() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ChunkFile::read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structChunkFile_1_1Chunk.html">ChunkFile::Chunk</a> &</td> <td class="paramname"><span class="paramname"><em>chunk</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">Referenced by <a class="el" href="classIndexFile.html#a3e6179daa1d2604e3f20541baf07c83e">IndexFile::read()</a>, and <a class="el" href="classIndexFile.html#a3f7f3e5d216848e937034f98627dbfa9">IndexFile::readPayload()</a>.</p>
</div>
</div>
<a id="a20b0a7cb9846509db14525b3221cdd3c" name="a20b0a7cb9846509db14525b3221cdd3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20b0a7cb9846509db14525b3221cdd3c">◆ </a></span>read() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ChunkFile::read </td>
<td>(</td>
<td class="paramtype">uint8_t *</td> <td class="paramname"><span class="paramname"><em>buffer</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t</td> <td class="paramname"><span class="paramname"><em>nbyte</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a5202b2b99ac9426ebfe8f310648f30d2" name="a5202b2b99ac9426ebfe8f310648f30d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5202b2b99ac9426ebfe8f310648f30d2">◆ </a></span>seek()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ChunkFile::seek </td>
<td>(</td>
<td class="paramtype">uint64_t</td> <td class="paramname"><span class="paramname"><em>offset</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">Referenced by <a class="el" href="classIndexFile.html#a847713c31e01d4e2b3ee3966ee0d174e">IndexFile::read()</a>, and <a class="el" href="classIndexFileBuilder.html#ad96867f425717a02661e47cd199043d9">IndexFileBuilder::stateNodeEnd()</a>.</p>
</div>
</div>
<a id="ab6a4ea3bafc07302501a2f2fefcd56ba" name="ab6a4ea3bafc07302501a2f2fefcd56ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6a4ea3bafc07302501a2f2fefcd56ba">◆ </a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t ChunkFile::size </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac9c3bd08c61121710290ca967865e3a8" name="ac9c3bd08c61121710290ca967865e3a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9c3bd08c61121710290ca967865e3a8">◆ </a></span>skip()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ChunkFile::skip </td>
<td>(</td>
<td class="paramtype">uint64_t</td> <td class="paramname"><span class="paramname"><em>nbyte</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a2eaf343a0aea445734fc42800590f5e3" name="a2eaf343a0aea445734fc42800590f5e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2eaf343a0aea445734fc42800590f5e3">◆ </a></span>status()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string ChunkFile::status </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</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 class="reference">Referenced by <a class="el" href="#a9f1b4b91acd806bfb1a5ef1f208e3035">validate()</a>.</p>
</div>
</div>
<a id="a9f1b4b91acd806bfb1a5ef1f208e3035" name="a9f1b4b91acd806bfb1a5ef1f208e3035"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f1b4b91acd806bfb1a5ef1f208e3035">◆ </a></span>validate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ChunkFile::validate </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structChunkFile_1_1Chunk.html">Chunk</a> &</td> <td class="paramname"><span class="paramname"><em>chunk</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>type</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t</td> <td class="paramname"><span class="paramname"><em>majorVersion</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t</td> <td class="paramname"><span class="paramname"><em>minorVersion</em></span> ) const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">Referenced by <a class="el" href="classIndexFile.html#a3f7f3e5d216848e937034f98627dbfa9">IndexFile::readPayload()</a>.</p>
</div>
</div>
<a id="aa760b32f0e8bf05b90e9e2a72a7ada26" name="aa760b32f0e8bf05b90e9e2a72a7ada26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa760b32f0e8bf05b90e9e2a72a7ada26">◆ </a></span>write() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ChunkFile::write </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structChunkFile_1_1Chunk.html">Chunk</a> &</td> <td class="paramname"><span class="paramname"><em>chunk</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">Referenced by <a class="el" href="classIndexFile.html#a9a30bc9213e44653b481986d8c8810f5">IndexFile::write()</a>.</p>
</div>
</div>
<a id="af5b13c13d369e2e3e42d4e88b6e8d096" name="af5b13c13d369e2e3e42d4e88b6e8d096"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5b13c13d369e2e3e42d4e88b6e8d096">◆ </a></span>write() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ChunkFile::write </td>
<td>(</td>
<td class="paramtype">const uint8_t *</td> <td class="paramname"><span class="paramname"><em>buffer</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t</td> <td class="paramname"><span class="paramname"><em>nbyte</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aeb986e42b8f608d030a86d0a60e529c3" name="aeb986e42b8f608d030a86d0a60e529c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb986e42b8f608d030a86d0a60e529c3">◆ </a></span>file_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classFile.html">File</a> ChunkFile::file_</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 class="reference">Referenced by <a class="el" href="#acbc09a8ef4b3e3dadeb554dfb34eaaa0">close()</a>, <a class="el" href="#a2fb378195a073690a52256cf641d7f36">eof()</a>, <a class="el" href="#ad7be485e45b63454038675095e025418">offset()</a>, <a class="el" href="#a7b6eb95120bf70cce3cd2a7e3d9f2d0d">open()</a>, <a class="el" href="#ab4cd56eb32c3afb330c5d218395d8122">path()</a>, <a class="el" href="#a9934f1a975b3e30fc194503dc15731c4">read()</a>, <a class="el" href="#a20b0a7cb9846509db14525b3221cdd3c">read()</a>, <a class="el" href="#a5202b2b99ac9426ebfe8f310648f30d2">seek()</a>, <a class="el" href="#ab6a4ea3bafc07302501a2f2fefcd56ba">size()</a>, <a class="el" href="#ac9c3bd08c61121710290ca967865e3a8">skip()</a>, <a class="el" href="#aa760b32f0e8bf05b90e9e2a72a7ada26">write()</a>, and <a class="el" href="#af5b13c13d369e2e3e42d4e88b6e8d096">write()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><b>ChunkFile.hpp</b></li>
<li><b>ChunkFile.cpp</b></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.4-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classChunkFile.html">ChunkFile</a></li>
<li class="footer">
Copyright 2020-present VUKOZ Documentation contributions included herein are the copyrights of their respective owners.
The documentation provided herein is licensed under the terms of the
<a href="https://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.
</li>
</ul>
</div>
</body>
</html>