| OpenMS 2.5.0

MSDataAggregatingConsumer.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/KERNEL/MSSpectrum.h>
42 #include <OpenMS/KERNEL/MSChromatogram.h>
43
44 namespace OpenMS
45 {
46
51 class OPENMS_DLLAPI MSDataAggregatingConsumer :
52 public Interfaces::IMSDataConsumer
53 {
54
55 Interfaces::IMSDataConsumer* next_consumer_;
56 double previous_rt_;
57 bool rt_initialized_;
58 SpectrumType s_tmp;
59 std::vector<SpectrumType> s_list;
60
61 public:
62
68 MSDataAggregatingConsumer(Interfaces::IMSDataConsumer* next_consumer) :
69 next_consumer_(next_consumer),
70 previous_rt_(0.0),
71 rt_initialized_(false)
72 {}
73
82 ~MSDataAggregatingConsumer() override;
83
84 void setExpectedSize(Size, Size) override {}
85
86 void consumeSpectrum(SpectrumType & s) override;
87
88 void consumeChromatogram(ChromatogramType & c) override;
89
90 void setExperimentalSettings(const OpenMS::ExperimentalSettings&) override {}
91
92 };
93
94 } //end namespace OpenMS
95
96
OpenMS::ExperimentalSettings
Description of the experimental settings.
Definition: ExperimentalSettings.h:59
OpenMS::MSChromatogram
The representation of a chromatogram.
Definition: MSChromatogram.h:54
OpenMS::MSDataAggregatingConsumer::next_consumer_
Interfaces::IMSDataConsumer * next_consumer_
Definition: MSDataAggregatingConsumer.h:55
OpenMS::MSDataAggregatingConsumer::MSDataAggregatingConsumer
MSDataAggregatingConsumer(Interfaces::IMSDataConsumer *next_consumer)
Constructor.
Definition: MSDataAggregatingConsumer.h:68
StandardTypes.h
OpenMS::MSDataAggregatingConsumer::rt_initialized_
bool rt_initialized_
Definition: MSDataAggregatingConsumer.h:57
OpenMS::MSDataAggregatingConsumer::s_tmp
SpectrumType s_tmp
Definition: MSDataAggregatingConsumer.h:58
OpenMS::MSSpectrum
The representation of a 1D spectrum.
Definition: MSSpectrum.h:67
OpenMS::MSDataAggregatingConsumer
Aggregates spectra by retention time.
Definition: MSDataAggregatingConsumer.h:51
OpenMS::MSDataAggregatingConsumer::previous_rt_
double previous_rt_
Definition: MSDataAggregatingConsumer.h:56
IMSDataConsumer.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::MSDataAggregatingConsumer::setExpectedSize
void setExpectedSize(Size, Size) override
Set expected size of spectra and chromatograms to be consumed.
Definition: MSDataAggregatingConsumer.h:84
OpenMS::Interfaces::IMSDataConsumer
The interface of a consumer of spectra and chromatograms.
Definition: IMSDataConsumer.h:69
MSSpectrum.h
OpenMS::Constants::c
const double c
MSChromatogram.h
OpenMS::MSDataAggregatingConsumer::setExperimentalSettings
void setExperimentalSettings(const OpenMS::ExperimentalSettings &) override
Set experimental settings (meta-data) of the data to be consumed.
Definition: MSDataAggregatingConsumer.h:90
OpenMS::MSDataAggregatingConsumer::s_list
std::vector< SpectrumType > s_list
Definition: MSDataAggregatingConsumer.h:59
OpenMS::Size
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127