Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Bzip2InputStream.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2017.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Timo Sachsenberg $
32 // $Authors: David Wojnar $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_FORMAT_BZIP2INPUTSTREAM_H
36 #define OPENMS_FORMAT_BZIP2INPUTSTREAM_H
37 
38 #include <xercesc/util/BinInputStream.hpp>
39 #include <xercesc/util/PlatformUtils.hpp>
41 
42 
43 namespace OpenMS
44 {
45  class String;
50  class OPENMS_DLLAPI Bzip2InputStream :
51  public xercesc::BinInputStream
52  {
53 public:
55  explicit Bzip2InputStream(const String& file_name);
56 
57  explicit Bzip2InputStream(const char* const file_name);
58 
59 
61  virtual ~Bzip2InputStream();
62 
64  bool getIsOpen() const;
65 
71  virtual XMLFilePos curPos() const;
72 
84  virtual XMLSize_t readBytes(XMLByte* const to_fill, const XMLSize_t max_to_read);
85 
95  virtual const XMLCh* getContentType() const;
96 
97 
98 private:
103 
104  //not implemented
106  Bzip2InputStream(const Bzip2InputStream& stream);
107  Bzip2InputStream& operator=(const Bzip2InputStream& stream);
108  };
109 
110  inline XMLFilePos Bzip2InputStream::curPos() const
111  {
112  return file_current_index_;
113  }
114 
115  inline bool Bzip2InputStream::getIsOpen() const
116  {
117  return bzip2_->isOpen();
118  }
119 
120 } // namespace OpenMS
121 
122 #endif // OPENMS_FORMAT_BZIP2InputStream_H
A more convenient string class.
Definition: String.h:57
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
virtual XMLFilePos curPos() const
returns the current position in the file
Definition: Bzip2InputStream.h:110
bool getIsOpen() const
returns true if file is open
Definition: Bzip2InputStream.h:115
Decompresses files which are compressed in the bzip2 format (*.bz2)
Definition: Bzip2Ifstream.h:47
Implements the BinInputStream class of the xerces-c library in order to read bzip2 compressed XML fil...
Definition: Bzip2InputStream.h:50
XMLSize_t file_current_index_
current index of the actual file
Definition: Bzip2InputStream.h:102
Bzip2Ifstream * bzip2_
pointer to an compression stream
Definition: Bzip2InputStream.h:100

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:21:59 using doxygen 1.8.13