Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
GzipInputStream.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-2015.
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: David Wojnar $
32 // $Authors: David Wojnar $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_FORMAT_GZIPINPUTSTREAM_H
36 #define OPENMS_FORMAT_GZIPINPUTSTREAM_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 GzipInputStream :
51  public xercesc::BinInputStream
52  {
53 public:
55  explicit GzipInputStream(const String& file_name);
56 
57  explicit GzipInputStream(const char* const file_name);
58 
59 
61  virtual ~GzipInputStream();
63  bool getIsOpen() const;
68  virtual XMLFilePos curPos() const;
69 
80  virtual XMLSize_t readBytes(XMLByte* const to_fill, const XMLSize_t max_to_read);
85  virtual const XMLCh* getContentType() const;
86 
87 
88 private:
93 
94  //not implemented
96  GzipInputStream(const GzipInputStream& stream);
97  GzipInputStream& operator=(const GzipInputStream& stream);
98  };
99 
100  inline XMLFilePos GzipInputStream::curPos() const
101  {
102  return file_current_index_;
103  }
104 
105  inline bool GzipInputStream::getIsOpen() const
106  {
107  return gzip_->isOpen();
108  }
109 
110 } // namespace OpenMS
111 
112 #endif // OPENMS_FORMAT_GZIPInputStream_H
Decompresses files which are compressed in the gzip format (*.gzip)
Definition: GzipIfstream.h:46
virtual XMLFilePos curPos() const
returns the current position in the file
Definition: GzipInputStream.h:100
A more convenient string class.
Definition: String.h:57
XMLSize_t file_current_index_
current index of the actual file
Definition: GzipInputStream.h:92
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
bool getIsOpen() const
returns true if file is open
Definition: GzipInputStream.h:105
Implements the BinInputStream class of the xerces-c library in order to read gzip compressed XML file...
Definition: GzipInputStream.h:50
GzipIfstream * gzip_
pointer to an compression stream
Definition: GzipInputStream.h:90
bool isOpen() const
returns whether a file is open.
Definition: GzipIfstream.h:130

OpenMS / TOPP release 2.0.0 Documentation generated on Tue Aug 25 2015 05:53:46 using doxygen 1.8.9.1