OpenMS  3.0.0
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-2022.
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 #pragma once
36 
37 #include <xercesc/util/BinInputStream.hpp>
38 #include <xercesc/util/PlatformUtils.hpp>
40 
41 
42 namespace OpenMS
43 {
44  class String;
49  class OPENMS_DLLAPI Bzip2InputStream :
50  public xercesc::BinInputStream
51  {
52 public:
54  explicit Bzip2InputStream(const String& file_name);
55 
56  explicit Bzip2InputStream(const char* const file_name);
57 
58 
60  ~Bzip2InputStream() override;
61 
63  bool getIsOpen() const;
64 
70  XMLFilePos curPos() const override;
71 
83  XMLSize_t readBytes(XMLByte* const to_fill, const XMLSize_t max_to_read) override;
84 
94  const XMLCh* getContentType() const override;
95 
96 
97 private:
102 
103  //not implemented
105  Bzip2InputStream(const Bzip2InputStream& stream);
106  Bzip2InputStream& operator=(const Bzip2InputStream& stream);
107  };
108 
109  inline XMLFilePos Bzip2InputStream::curPos() const
110  {
111  return file_current_index_;
112  }
113 
114  inline bool Bzip2InputStream::getIsOpen() const
115  {
116  return bzip2_->isOpen();
117  }
118 
119 } // namespace OpenMS
120 
OpenMS::Bzip2Ifstream::isOpen
bool isOpen() const
returns whether a file is open.
Definition: Bzip2Ifstream.h:113
OpenMS::Bzip2InputStream::getIsOpen
bool getIsOpen() const
returns true if file is open
Definition: Bzip2InputStream.h:114
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::Bzip2InputStream
Implements the BinInputStream class of the xerces-c library in order to read bzip2 compressed XML fil...
Definition: Bzip2InputStream.h:49
OpenMS::Bzip2InputStream::file_current_index_
XMLSize_t file_current_index_
current index of the actual file
Definition: Bzip2InputStream.h:101
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::Bzip2Ifstream
Decompresses files which are compressed in the bzip2 format (*.bz2)
Definition: Bzip2Ifstream.h:46
OpenMS::Bzip2InputStream::bzip2_
Bzip2Ifstream * bzip2_
pointer to an compression stream
Definition: Bzip2InputStream.h:99
Bzip2Ifstream.h
OpenMS::Bzip2InputStream::curPos
XMLFilePos curPos() const override
returns the current position in the file
Definition: Bzip2InputStream.h:109