| OpenMS 2.5.0

IMSDataConsumer.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/config.h>
38 #include <OpenMS/KERNEL/StandardDeclarations.h>
39 #include <OpenMS/CONCEPT/Types.h>
40
41 namespace OpenMS
42 {
43
44 namespace Interfaces
45 {
46
69 class OPENMS_DLLAPI IMSDataConsumer
70 {
71 public:
72 typedef MSSpectrum SpectrumType;
73 typedef MSChromatogram ChromatogramType;
74
75 virtual ~IMSDataConsumer() {}
76
86 virtual void consumeSpectrum(SpectrumType & s) = 0;
87
97 virtual void consumeChromatogram(ChromatogramType &) = 0;
98
111 virtual void setExpectedSize(size_t expectedSpectra, size_t expectedChromatograms) = 0;
112
124 virtual void setExperimentalSettings(const ExperimentalSettings& exp) = 0;
125 };
126
127 typedef IMSDataConsumer IMSDataConsumer;
128
129 } //end namespace Interfaces
130 } //end namespace OpenMS
131
OpenMS::ExperimentalSettings
Description of the experimental settings.
Definition: ExperimentalSettings.h:59
OpenMS::MSChromatogram
The representation of a chromatogram.
Definition: MSChromatogram.h:54
OpenMS::Interfaces::IMSDataConsumer::ChromatogramType
MSChromatogram ChromatogramType
Definition: IMSDataConsumer.h:73
OpenMS::Interfaces::IMSDataConsumer
IMSDataConsumer IMSDataConsumer
Definition: IMSDataConsumer.h:127
StandardDeclarations.h
Types.h
OpenMS::Interfaces::IMSDataConsumer::~IMSDataConsumer
virtual ~IMSDataConsumer()
Definition: IMSDataConsumer.h:75
OpenMS::MSSpectrum
The representation of a 1D spectrum.
Definition: MSSpectrum.h:67
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::Interfaces::IMSDataConsumer::SpectrumType
MSSpectrum SpectrumType
Definition: IMSDataConsumer.h:72
OpenMS::Interfaces::IMSDataConsumer
The interface of a consumer of spectra and chromatograms.
Definition: IMSDataConsumer.h:69