OpenMS
ZlibCompression.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-2023.
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: Hannes Roest $
32 // $Authors: Hannes Roest $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <OpenMS/CONCEPT/Types.h>
38 #include <OpenMS/OpenMSConfig.h>
40 
41 #include <string>
42 #include <vector>
43 #include <QByteArray>
44 
45 namespace OpenMS
46 {
47  class String;
48 
56  class OPENMS_DLLAPI ZlibCompression
57  {
58 public:
59 
67  static void compressString(std::string& raw_data, std::string& compressed_data);
68 
76  static void compressString(const QByteArray& raw_data, QByteArray& compressed_data);
77 
86  static void uncompressString(const void * compressed_data, size_t nr_bytes, std::string& raw_data);
87 
95  static void uncompressString(const QByteArray& compressed_data, QByteArray& raw_data);
96 
97  };
98 
99 } // namespace OpenMS
100 
101 
Compresses and uncompresses data using zlib.
Definition: ZlibCompression.h:57
static void uncompressString(const void *compressed_data, size_t nr_bytes, std::string &raw_data)
Uncompresses data using Qt (wrapper around Qt function)
static void compressString(std::string &raw_data, std::string &compressed_data)
Compresses data using zlib directly.
static void compressString(const QByteArray &raw_data, QByteArray &compressed_data)
Compresses data using Qt.
static void uncompressString(const QByteArray &compressed_data, QByteArray &raw_data)
Uncompresses data using Qt.
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48