OpenMS  3.0.0
MSDataSqlConsumer.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: Hannes Roest $
32 // $Authors: Hannes Roest $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 
40 
41 namespace OpenMS
42 {
43 
44  namespace Internal
45  {
46  class MzMLSqliteHandler;
47  }
48 
60  class OPENMS_DLLAPI MSDataSqlConsumer :
62  {
66 
67  public:
68 
81  MSDataSqlConsumer(const String& sql_filename, UInt64 run_id, int buffer_size = 500, bool full_meta = true, bool lossy_compression=false, double linear_mass_acc=1e-4);
82 
88  ~MSDataSqlConsumer() override;
89 
96  void flush();
97 
101  void consumeSpectrum(SpectrumType & s) override;
102 
106  void consumeChromatogram(ChromatogramType & c) override;
107 
108  void setExpectedSize(Size /* expectedSpectra */, Size /* expectedChromatograms */) override;
109 
110  void setExperimentalSettings(const ExperimentalSettings& /* exp */) override;
111 
112  protected:
113 
116 
117  size_t flush_after_;
119  std::vector<SpectrumType> spectra_;
120  std::vector<ChromatogramType> chromatograms_;
121 
123  };
124 
125 } //end namespace OpenMS
126 
127 
OpenMS::UInt64
OPENMS_UINT64_TYPE UInt64
Unsigned integer type (64bit)
Definition: Types.h:77
OpenMS::Internal::MzMLSqliteHandler
Sqlite handler for storing spectra and chromatograms in sqMass format.
Definition: MzMLSqliteHandler.h:77
OpenMS::Interfaces::IMSDataConsumer
The interface of a consumer of spectra and chromatograms.
Definition: IMSDataConsumer.h:69
OpenMS::MSDataSqlConsumer::filename_
String filename_
Definition: MSDataSqlConsumer.h:114
OpenMS::MSDataSqlConsumer::SpectrumType
MapType::SpectrumType SpectrumType
Definition: MSDataSqlConsumer.h:64
OpenMS::ExperimentalSettings
Description of the experimental settings.
Definition: ExperimentalSettings.h:59
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::MSDataSqlConsumer::chromatograms_
std::vector< ChromatogramType > chromatograms_
Definition: MSDataSqlConsumer.h:120
OpenMS::MSExperiment
In-Memory representation of a mass spectrometry run.
Definition: MSExperiment.h:70
OpenMS::Size
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127
OpenMS::Constants::c
const double c
Definition: Constants.h:209
IMSDataConsumer.h
OpenMS::MSDataSqlConsumer::peak_meta_
MSExperiment peak_meta_
Definition: MSDataSqlConsumer.h:122
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::MSDataSqlConsumer
A data consumer that inserts MS data into a SQLite database.
Definition: MSDataSqlConsumer.h:60
OpenMS::MSDataSqlConsumer::handler_
OpenMS::Internal::MzMLSqliteHandler * handler_
Definition: MSDataSqlConsumer.h:115
OpenMS::MSDataSqlConsumer::MapType
MSExperiment MapType
Definition: MSDataSqlConsumer.h:63
MSExperiment.h
OpenMS::MSDataSqlConsumer::full_meta_
bool full_meta_
Definition: MSDataSqlConsumer.h:118
OpenMS::MSChromatogram
The representation of a chromatogram.
Definition: MSChromatogram.h:53
OpenMS::MSDataSqlConsumer::spectra_
std::vector< SpectrumType > spectra_
Definition: MSDataSqlConsumer.h:119
OpenMS::MSDataSqlConsumer::ChromatogramType
MapType::ChromatogramType ChromatogramType
Definition: MSDataSqlConsumer.h:65
OpenMS::MSDataSqlConsumer::flush_after_
size_t flush_after_
Definition: MSDataSqlConsumer.h:117
OpenMS::MSSpectrum
The representation of a 1D spectrum.
Definition: MSSpectrum.h:66