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
|
<HTML>
<HEAD>
<TITLE>Bzip2Ifstream.h Source File</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="dir_e770f0cf77e550adde3f44739ef529fe.html">include</a></li><li class="navelem"><a class="el" href="dir_6a63c4937d4da007e55fff5dcf71e0f8.html">OpenMS</a></li><li class="navelem"><a class="el" href="dir_d1695c75ee0aa48d87e52f45c7decd7a.html">FORMAT</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Bzip2Ifstream.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="Bzip2Ifstream_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// --------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// OpenMS -- Open-Source Mass Spectrometry</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// --------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// ETH Zurich, and Freie Universitaet Berlin 2002-2013.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">//</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// This software is released under a three-clause BSD license:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// * Redistributions of source code must retain the above copyright</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// notice, this list of conditions and the following disclaimer.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// * Redistributions in binary form must reproduce the above copyright</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// notice, this list of conditions and the following disclaimer in the</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// documentation and/or other materials provided with the distribution.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// * Neither the name of any author or any participating institution</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// may be used to endorse or promote products derived from this software</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// without specific prior written permission.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// For a full list of authors, refer to the file AUTHORS.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// --------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">//</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// --------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// $Maintainer: David Wojnar $</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// $Authors: David Wojnar $</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// --------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#ifndef OPENMS_FORMAT_BZIP2IFSTREAM_H</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor"></span><span class="preprocessor">#define OPENMS_FORMAT_BZIP2IFSTREAM_H</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#include <OpenMS/config.h></span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#include <bzlib.h></span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#include <istream></span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">namespace </span>OpenMS</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> {</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classOpenMS_1_1Bzip2Ifstream.html"> 47</a></span>  <span class="keyword">class </span>OPENMS_DLLAPI <a class="code" href="classOpenMS_1_1Bzip2Ifstream.html">Bzip2Ifstream</a></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  {</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="classOpenMS_1_1Bzip2Ifstream.html">Bzip2Ifstream</a>();</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classOpenMS_1_1Bzip2Ifstream.html">Bzip2Ifstream</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> * filename);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">virtual</span> ~<a class="code" href="classOpenMS_1_1Bzip2Ifstream.html">Bzip2Ifstream</a>();</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">size_t</span> read(<span class="keywordtype">char</span> * s, <span class="keywordtype">size_t</span> n);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">bool</span> streamEnd() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">bool</span> isOpen() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">void</span> open(<span class="keyword">const</span> <span class="keywordtype">char</span> * filename);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">void</span> close();</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="classOpenMS_1_1Bzip2Ifstream.html#a715b2a1d4ad04ec0c950d1467f91964e"> 94</a></span>  FILE * <a class="code" href="classOpenMS_1_1Bzip2Ifstream.html#a715b2a1d4ad04ec0c950d1467f91964e">file_</a>;</div>
<div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="classOpenMS_1_1Bzip2Ifstream.html#aae5d7bd14e8d3e31613c02a30fdda18e"> 96</a></span>  BZFILE * <a class="code" href="classOpenMS_1_1Bzip2Ifstream.html#aae5d7bd14e8d3e31613c02a30fdda18e">bzip2file_</a>;</div>
<div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="classOpenMS_1_1Bzip2Ifstream.html#ab4d91b6d6d8ce177666aae0134e661d5"> 98</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classOpenMS_1_1Bzip2Ifstream.html#ab4d91b6d6d8ce177666aae0134e661d5">n_buffer_</a>;</div>
<div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="classOpenMS_1_1Bzip2Ifstream.html#a20f950de073185ed73a2f52645b10526"> 100</a></span>  <span class="keywordtype">int</span> <a class="code" href="classOpenMS_1_1Bzip2Ifstream.html#a20f950de073185ed73a2f52645b10526">bzerror_</a>;</div>
<div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="classOpenMS_1_1Bzip2Ifstream.html#a5bc5b565c935f4accdf0d7d240301bdc"> 102</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classOpenMS_1_1Bzip2Ifstream.html#a5bc5b565c935f4accdf0d7d240301bdc">stream_at_end_</a>;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="comment">//not implemented</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <a class="code" href="classOpenMS_1_1Bzip2Ifstream.html">Bzip2Ifstream</a>(<span class="keyword">const</span> <a class="code" href="classOpenMS_1_1Bzip2Ifstream.html">Bzip2Ifstream</a> & bzip2);</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="classOpenMS_1_1Bzip2Ifstream.html">Bzip2Ifstream</a> & operator=(<span class="keyword">const</span> <a class="code" href="classOpenMS_1_1Bzip2Ifstream.html">Bzip2Ifstream</a> & bzip2);</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  };</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="comment">//return bzip2file???!!!!????</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="classOpenMS_1_1Bzip2Ifstream.html#a3c7351cec1380d07f9e4b3ec96b2b1ff"> 110</a></span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classOpenMS_1_1Bzip2Ifstream.html#a3c7351cec1380d07f9e4b3ec96b2b1ff">Bzip2Ifstream::isOpen</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordflow">return</span> <a class="code" href="classOpenMS_1_1Bzip2Ifstream.html#a715b2a1d4ad04ec0c950d1467f91964e">file_</a> != <a class="code" href="IsotopeWaveletParallelFor_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  }</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="classOpenMS_1_1Bzip2Ifstream.html#a5e93134387edbe53b3ae66852a37eb1f"> 115</a></span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classOpenMS_1_1Bzip2Ifstream.html#a5e93134387edbe53b3ae66852a37eb1f">Bzip2Ifstream::streamEnd</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordflow">return</span> <a class="code" href="classOpenMS_1_1Bzip2Ifstream.html#a5bc5b565c935f4accdf0d7d240301bdc">stream_at_end_</a>;</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  }</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> } <span class="comment">//namespace OpenMS</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="preprocessor">#endif //OPENMS_FORMAT_BZIP2IFSTREAM_H</span></div>
<div class="ttc" id="classOpenMS_1_1Bzip2Ifstream_html_a5e93134387edbe53b3ae66852a37eb1f"><div class="ttname"><a href="classOpenMS_1_1Bzip2Ifstream.html#a5e93134387edbe53b3ae66852a37eb1f">OpenMS::Bzip2Ifstream::streamEnd</a></div><div class="ttdeci">bool streamEnd() const </div><div class="ttdoc">indicates whether the read function can be used safely </div><div class="ttdef"><b>Definition:</b> Bzip2Ifstream.h:115</div></div>
<div class="ttc" id="classOpenMS_1_1Bzip2Ifstream_html_a3c7351cec1380d07f9e4b3ec96b2b1ff"><div class="ttname"><a href="classOpenMS_1_1Bzip2Ifstream.html#a3c7351cec1380d07f9e4b3ec96b2b1ff">OpenMS::Bzip2Ifstream::isOpen</a></div><div class="ttdeci">bool isOpen() const </div><div class="ttdoc">returns whether a file is open. </div><div class="ttdef"><b>Definition:</b> Bzip2Ifstream.h:110</div></div>
<div class="ttc" id="IsotopeWaveletParallelFor_8h_html_a070d2ce7b6bb7e5c05602aa8c308d0c4"><div class="ttname"><a href="IsotopeWaveletParallelFor_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a></div><div class="ttdeci">#define NULL</div><div class="ttdef"><b>Definition:</b> IsotopeWaveletParallelFor.h:41</div></div>
<div class="ttc" id="classOpenMS_1_1Bzip2Ifstream_html_a5bc5b565c935f4accdf0d7d240301bdc"><div class="ttname"><a href="classOpenMS_1_1Bzip2Ifstream.html#a5bc5b565c935f4accdf0d7d240301bdc">OpenMS::Bzip2Ifstream::stream_at_end_</a></div><div class="ttdeci">bool stream_at_end_</div><div class="ttdoc">true if end of file is reached </div><div class="ttdef"><b>Definition:</b> Bzip2Ifstream.h:102</div></div>
<div class="ttc" id="classOpenMS_1_1Bzip2Ifstream_html_a20f950de073185ed73a2f52645b10526"><div class="ttname"><a href="classOpenMS_1_1Bzip2Ifstream.html#a20f950de073185ed73a2f52645b10526">OpenMS::Bzip2Ifstream::bzerror_</a></div><div class="ttdeci">int bzerror_</div><div class="ttdoc">saves the last returned error by the read function </div><div class="ttdef"><b>Definition:</b> Bzip2Ifstream.h:100</div></div>
<div class="ttc" id="classOpenMS_1_1Bzip2Ifstream_html_a715b2a1d4ad04ec0c950d1467f91964e"><div class="ttname"><a href="classOpenMS_1_1Bzip2Ifstream.html#a715b2a1d4ad04ec0c950d1467f91964e">OpenMS::Bzip2Ifstream::file_</a></div><div class="ttdeci">FILE * file_</div><div class="ttdoc">pointer to a FILE object. Necessary for opening the file </div><div class="ttdef"><b>Definition:</b> Bzip2Ifstream.h:94</div></div>
<div class="ttc" id="classOpenMS_1_1Bzip2Ifstream_html"><div class="ttname"><a href="classOpenMS_1_1Bzip2Ifstream.html">OpenMS::Bzip2Ifstream</a></div><div class="ttdoc">Decompresses files which are compressed in the bzip2 format (*.bz2) </div><div class="ttdef"><b>Definition:</b> Bzip2Ifstream.h:47</div></div>
<div class="ttc" id="classOpenMS_1_1Bzip2Ifstream_html_ab4d91b6d6d8ce177666aae0134e661d5"><div class="ttname"><a href="classOpenMS_1_1Bzip2Ifstream.html#ab4d91b6d6d8ce177666aae0134e661d5">OpenMS::Bzip2Ifstream::n_buffer_</a></div><div class="ttdeci">size_t n_buffer_</div><div class="ttdoc">counts the last read buffer </div><div class="ttdef"><b>Definition:</b> Bzip2Ifstream.h:98</div></div>
<div class="ttc" id="classOpenMS_1_1Bzip2Ifstream_html_aae5d7bd14e8d3e31613c02a30fdda18e"><div class="ttname"><a href="classOpenMS_1_1Bzip2Ifstream.html#aae5d7bd14e8d3e31613c02a30fdda18e">OpenMS::Bzip2Ifstream::bzip2file_</a></div><div class="ttdeci">BZFILE * bzip2file_</div><div class="ttdoc">a pointer to a BZFILE object. Necessary for decompression </div><div class="ttdef"><b>Definition:</b> Bzip2Ifstream.h:96</div></div>
</div><!-- fragment --></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:11 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
