| OpenMS 2.5.0

MSDataCachedConsumer.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-2020.
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/INTERFACES/IMSDataConsumer.h>
38
39 #include <OpenMS/KERNEL/StandardTypes.h>
40
41 #include <OpenMS/FORMAT/HANDLERS/CachedMzMLHandler.h>
42
43
44 namespace OpenMS
45 {
46
54 class OPENMS_DLLAPI MSDataCachedConsumer :
55 public Internal::CachedMzMLHandler,
56 public Interfaces::IMSDataConsumer
57 {
58 typedef MSSpectrum SpectrumType;
59 typedef MSChromatogram ChromatogramType;
60
61 public:
62
77 MSDataCachedConsumer(const String& filename, bool clearData=true);
78
84 ~MSDataCachedConsumer() override;
85
91 void consumeSpectrum(SpectrumType & s) override;
92
98 void consumeChromatogram(ChromatogramType & c) override;
99
100 void setExpectedSize(Size /* expectedSpectra */, Size /* expectedChromatograms */) override {;}
101
102 void setExperimentalSettings(const ExperimentalSettings& /* exp */) override {;}
103
104 protected:
105 std::ofstream ofs_;
106 bool clearData_;
107 Size spectra_written_;
108 Size chromatograms_written_;
109
110 };
111
112 } //end namespace OpenMS
113
OpenMS::ExperimentalSettings
Description of the experimental settings.
Definition: ExperimentalSettings.h:59
OpenMS::MSDataCachedConsumer::setExpectedSize
void setExpectedSize(Size, Size) override
Set expected size of spectra and chromatograms to be consumed.
Definition: MSDataCachedConsumer.h:100
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::MSChromatogram
The representation of a chromatogram.
Definition: MSChromatogram.h:54
OpenMS::MSDataCachedConsumer
Transforming and cached writing consumer of MS data.
Definition: MSDataCachedConsumer.h:54
OpenMS::Internal::CachedMzMLHandler
An class that uses on-disk caching to read and write spectra and chromatograms.
Definition: CachedMzMLHandler.h:66
StandardTypes.h
OpenMS::MSDataCachedConsumer::ofs_
std::ofstream ofs_
Definition: MSDataCachedConsumer.h:105
CachedMzMLHandler.h
OpenMS::MSDataCachedConsumer::ChromatogramType
MSChromatogram ChromatogramType
Definition: MSDataCachedConsumer.h:59
OpenMS::MSSpectrum
The representation of a 1D spectrum.
Definition: MSSpectrum.h:67
OpenMS::MSDataCachedConsumer::spectra_written_
Size spectra_written_
Definition: MSDataCachedConsumer.h:107
OpenMS::MSDataCachedConsumer::clearData_
bool clearData_
Definition: MSDataCachedConsumer.h:106
IMSDataConsumer.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::MSDataCachedConsumer::chromatograms_written_
Size chromatograms_written_
Definition: MSDataCachedConsumer.h:108
OpenMS::Interfaces::IMSDataConsumer
The interface of a consumer of spectra and chromatograms.
Definition: IMSDataConsumer.h:69
OpenMS::Constants::c
const double c
OpenMS::Size
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127
OpenMS::MSDataCachedConsumer::SpectrumType
MSSpectrum SpectrumType
Definition: MSDataCachedConsumer.h:58
OpenMS::MSDataCachedConsumer::setExperimentalSettings
void setExperimentalSettings(const ExperimentalSettings &) override
Set experimental settings (meta-data) of the data to be consumed.
Definition: MSDataCachedConsumer.h:102