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
|
<HTML>
<HEAD>
<TITLE>Bzip2InputStream Class Reference</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<A href="index.html">Home</A> ·
<A href="classes.html">Classes</A> ·
<A href="annotated.html">Annotated Classes</A> ·
<A href="modules.html">Modules</A> ·
<A href="functions_func.html">Members</A> ·
<A href="namespaces.html">Namespaces</A> ·
<A href="pages.html">Related Pages</A>
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<!-- Generated by Doxygen 1.8.5 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="classOpenMS_1_1Bzip2InputStream.html">Bzip2InputStream</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<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="classOpenMS_1_1Bzip2InputStream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Bzip2InputStream Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Implements the BinInputStream class of the xerces-c library in order to read bzip2 compressed XML files.
<a href="classOpenMS_1_1Bzip2InputStream.html#details">More...</a></p>
<p><code>#include <<a class="el" href="Bzip2InputStream_8h_source.html">OpenMS/FORMAT/Bzip2InputStream.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Bzip2InputStream:</div>
<div class="dyncontent">
<div class="center">
<img src="classOpenMS_1_1Bzip2InputStream.png" usemap="#Bzip2InputStream_map" alt=""/>
<map id="Bzip2InputStream_map" name="Bzip2InputStream_map">
</map>
</div></div>
<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:a58c2afc57cc602bea3895f7beaee105b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Bzip2InputStream.html#a58c2afc57cc602bea3895f7beaee105b">Bzip2InputStream</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &file_name)</td></tr>
<tr class="memdesc:a58c2afc57cc602bea3895f7beaee105b"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a58c2afc57cc602bea3895f7beaee105b">More...</a><br/></td></tr>
<tr class="separator:a58c2afc57cc602bea3895f7beaee105b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9056a21d9bb27ab0f4857f6ea2766a3d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Bzip2InputStream.html#a9056a21d9bb27ab0f4857f6ea2766a3d">Bzip2InputStream</a> (const char *const file_name)</td></tr>
<tr class="separator:a9056a21d9bb27ab0f4857f6ea2766a3d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89adba675d5a98801a6907d5ea6c9761"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Bzip2InputStream.html#a89adba675d5a98801a6907d5ea6c9761">~Bzip2InputStream</a> ()</td></tr>
<tr class="memdesc:a89adba675d5a98801a6907d5ea6c9761"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a89adba675d5a98801a6907d5ea6c9761">More...</a><br/></td></tr>
<tr class="separator:a89adba675d5a98801a6907d5ea6c9761"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae6716799ee9bfc6da096d80df18158d6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Bzip2InputStream.html#ae6716799ee9bfc6da096d80df18158d6">getIsOpen</a> () const </td></tr>
<tr class="memdesc:ae6716799ee9bfc6da096d80df18158d6"><td class="mdescLeft"> </td><td class="mdescRight">returns true if file is open <a href="#ae6716799ee9bfc6da096d80df18158d6">More...</a><br/></td></tr>
<tr class="separator:ae6716799ee9bfc6da096d80df18158d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f7cf5e7696e8f6c80c3d81408c684ec"><td class="memItemLeft" align="right" valign="top">virtual XMLFilePos </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Bzip2InputStream.html#a4f7cf5e7696e8f6c80c3d81408c684ec">curPos</a> () const </td></tr>
<tr class="memdesc:a4f7cf5e7696e8f6c80c3d81408c684ec"><td class="mdescLeft"> </td><td class="mdescRight">returns the current position in the file <a href="#a4f7cf5e7696e8f6c80c3d81408c684ec">More...</a><br/></td></tr>
<tr class="separator:a4f7cf5e7696e8f6c80c3d81408c684ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1fdd11d10f16eaac816ee6b67a7b13f6"><td class="memItemLeft" align="right" valign="top">virtual XMLSize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Bzip2InputStream.html#a1fdd11d10f16eaac816ee6b67a7b13f6">readBytes</a> (XMLByte *const to_fill, const XMLSize_t max_to_read)</td></tr>
<tr class="memdesc:a1fdd11d10f16eaac816ee6b67a7b13f6"><td class="mdescLeft"> </td><td class="mdescRight">writes bytes into buffer from file <a href="#a1fdd11d10f16eaac816ee6b67a7b13f6">More...</a><br/></td></tr>
<tr class="separator:a1fdd11d10f16eaac816ee6b67a7b13f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2915c0848d905bf6d62a7bd935de00d4"><td class="memItemLeft" align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Bzip2InputStream.html#a2915c0848d905bf6d62a7bd935de00d4">getContentType</a> () const </td></tr>
<tr class="memdesc:a2915c0848d905bf6d62a7bd935de00d4"><td class="mdescLeft"> </td><td class="mdescRight">returns 0 <a href="#a2915c0848d905bf6d62a7bd935de00d4">More...</a><br/></td></tr>
<tr class="separator:a2915c0848d905bf6d62a7bd935de00d4"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:ae7a7fc7c4860246f4dfd22cf1238d046"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Bzip2InputStream.html#ae7a7fc7c4860246f4dfd22cf1238d046">Bzip2InputStream</a> ()</td></tr>
<tr class="separator:ae7a7fc7c4860246f4dfd22cf1238d046"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ef7ab5af9460f72fd5f1b007a98c609"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Bzip2InputStream.html#a2ef7ab5af9460f72fd5f1b007a98c609">Bzip2InputStream</a> (const <a class="el" href="classOpenMS_1_1Bzip2InputStream.html">Bzip2InputStream</a> &stream)</td></tr>
<tr class="separator:a2ef7ab5af9460f72fd5f1b007a98c609"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a56096a61726c212811c24c072edb853d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1Bzip2InputStream.html">Bzip2InputStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Bzip2InputStream.html#a56096a61726c212811c24c072edb853d">operator=</a> (const <a class="el" href="classOpenMS_1_1Bzip2InputStream.html">Bzip2InputStream</a> &stream)</td></tr>
<tr class="separator:a56096a61726c212811c24c072edb853d"><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:af46933b1989ffbdb1ac234d20957c393"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1Bzip2Ifstream.html">Bzip2Ifstream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Bzip2InputStream.html#af46933b1989ffbdb1ac234d20957c393">bzip2_</a></td></tr>
<tr class="memdesc:af46933b1989ffbdb1ac234d20957c393"><td class="mdescLeft"> </td><td class="mdescRight">pointer to an compression stream <a href="#af46933b1989ffbdb1ac234d20957c393">More...</a><br/></td></tr>
<tr class="separator:af46933b1989ffbdb1ac234d20957c393"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e417bbf1dd93b7f08dcd814f5e1d1ec"><td class="memItemLeft" align="right" valign="top">XMLSize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Bzip2InputStream.html#a4e417bbf1dd93b7f08dcd814f5e1d1ec">file_current_index_</a></td></tr>
<tr class="memdesc:a4e417bbf1dd93b7f08dcd814f5e1d1ec"><td class="mdescLeft"> </td><td class="mdescRight">current index of the actual file <a href="#a4e417bbf1dd93b7f08dcd814f5e1d1ec">More...</a><br/></td></tr>
<tr class="separator:a4e417bbf1dd93b7f08dcd814f5e1d1ec"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implements the BinInputStream class of the xerces-c library in order to read bzip2 compressed XML files. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a58c2afc57cc602bea3895f7beaee105b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1Bzip2InputStream.html">Bzip2InputStream</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> & </td>
<td class="paramname"><em>file_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<a class="anchor" id="a9056a21d9bb27ab0f4857f6ea2766a3d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1Bzip2InputStream.html">Bzip2InputStream</a> </td>
<td>(</td>
<td class="paramtype">const char *const </td>
<td class="paramname"><em>file_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a89adba675d5a98801a6907d5ea6c9761"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classOpenMS_1_1Bzip2InputStream.html">Bzip2InputStream</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<a class="anchor" id="ae7a7fc7c4860246f4dfd22cf1238d046"></a>
<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="classOpenMS_1_1Bzip2InputStream.html">Bzip2InputStream</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a2ef7ab5af9460f72fd5f1b007a98c609"></a>
<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="classOpenMS_1_1Bzip2InputStream.html">Bzip2InputStream</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1Bzip2InputStream.html">Bzip2InputStream</a> & </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a4f7cf5e7696e8f6c80c3d81408c684ec"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">XMLFilePos curPos </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>returns the current position in the file </p>
<dl class="section note"><dt>Note</dt><dd>Implementation of the xerces-c input stream interface </dd></dl>
<p>References <a class="el" href="classOpenMS_1_1Bzip2InputStream.html#a4e417bbf1dd93b7f08dcd814f5e1d1ec">Bzip2InputStream::file_current_index_</a>.</p>
</div>
</div>
<a class="anchor" id="a2915c0848d905bf6d62a7bd935de00d4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const XMLCh* getContentType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>returns 0 </p>
<dl class="section note"><dt>Note</dt><dd>Implementation of the xerces-c input stream interface </dd></dl>
</div>
</div>
<a class="anchor" id="ae6716799ee9bfc6da096d80df18158d6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool getIsOpen </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>returns true if file is open </p>
<p>References <a class="el" href="classOpenMS_1_1Bzip2InputStream.html#af46933b1989ffbdb1ac234d20957c393">Bzip2InputStream::bzip2_</a>, and <a class="el" href="classOpenMS_1_1Bzip2Ifstream.html#a3c7351cec1380d07f9e4b3ec96b2b1ff">Bzip2Ifstream::isOpen()</a>.</p>
</div>
</div>
<a class="anchor" id="a56096a61726c212811c24c072edb853d"></a>
<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="classOpenMS_1_1Bzip2InputStream.html">Bzip2InputStream</a>& operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1Bzip2InputStream.html">Bzip2InputStream</a> & </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a1fdd11d10f16eaac816ee6b67a7b13f6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual XMLSize_t readBytes </td>
<td>(</td>
<td class="paramtype">XMLByte *const </td>
<td class="paramname"><em>to_fill</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLSize_t </td>
<td class="paramname"><em>max_to_read</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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>writes bytes into buffer from file </p>
<dl class="section note"><dt>Note</dt><dd>Implementation of the xerces-c input stream interface</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">to_fill</td><td>is the buffer which is written to </td></tr>
<tr><td class="paramname">max_to_read</td><td>is the size of the buffer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>returns the number of bytes which were actually read </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="af46933b1989ffbdb1ac234d20957c393"></a>
<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="classOpenMS_1_1Bzip2Ifstream.html">Bzip2Ifstream</a>* bzip2_</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>pointer to an compression stream </p>
<p>Referenced by <a class="el" href="classOpenMS_1_1Bzip2InputStream.html#ae6716799ee9bfc6da096d80df18158d6">Bzip2InputStream::getIsOpen()</a>.</p>
</div>
</div>
<a class="anchor" id="a4e417bbf1dd93b7f08dcd814f5e1d1ec"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">XMLSize_t file_current_index_</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>current index of the actual file </p>
<p>Referenced by <a class="el" href="classOpenMS_1_1Bzip2InputStream.html#a4f7cf5e7696e8f6c80c3d81408c684ec">Bzip2InputStream::curPos()</a>.</p>
</div>
</div>
</div><!-- contents -->
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<TABLE width="100%" border="0">
<TR>
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:30 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
