Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
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-2017.
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 #ifndef OPENMS_FORMAT_DATAACCESS_MSDATAAGGREGATINGCONSUMER_H
36 #define OPENMS_FORMAT_DATAACCESS_MSDATAAGGREGATINGCONSUMER_H
37 
39 
41 
44 
45 namespace OpenMS
46 {
47 
52  class OPENMS_DLLAPI MSDataAggregatingConsumer :
54  {
55 
57  double previous_rt_;
60  std::vector<SpectrumType> s_list;
61 
62  public:
63 
70  next_consumer_(next_consumer),
71  previous_rt_(0.0),
72  rt_initialized_(false)
73  {}
74 
83  virtual ~MSDataAggregatingConsumer();
84 
85  virtual void setExpectedSize(Size, Size) {}
86 
87  virtual void consumeSpectrum(SpectrumType & s);
88 
89  virtual void consumeChromatogram(ChromatogramType & c);
90 
92 
93  };
94 
95 } //end namespace OpenMS
96 
97 #endif // OPENMS_FORMAT_DATAACCESS_MSDATAAGGREGATINGCONSUMER_H
98 
The representation of a chromatogram.
Definition: MSChromatogram.h:55
Aggregates spectra by retention time.
Definition: MSDataAggregatingConsumer.h:52
bool rt_initialized_
Definition: MSDataAggregatingConsumer.h:58
const double c
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
The representation of a 1D spectrum.
Definition: MSSpectrum.h:67
MSDataAggregatingConsumer(Interfaces::IMSDataConsumer *next_consumer)
Constructor.
Definition: MSDataAggregatingConsumer.h:69
virtual void setExpectedSize(Size, Size)
Set expected size of spectra and chromatograms to be consumed.
Definition: MSDataAggregatingConsumer.h:85
SpectrumType s_tmp
Definition: MSDataAggregatingConsumer.h:59
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:128
The interface of a consumer of spectra and chromatograms.
Definition: IMSDataConsumer.h:68
Interfaces::IMSDataConsumer * next_consumer_
Definition: MSDataAggregatingConsumer.h:56
virtual void setExperimentalSettings(const OpenMS::ExperimentalSettings &)
Set experimental settings (meta-data) of the data to be consumed.
Definition: MSDataAggregatingConsumer.h:91
std::vector< SpectrumType > s_list
Definition: MSDataAggregatingConsumer.h:60
double previous_rt_
Definition: MSDataAggregatingConsumer.h:57
Description of the experimental settings.
Definition: ExperimentalSettings.h:59

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:22:02 using doxygen 1.8.13