OpenMS
IMSDataConsumer.h
Go to the documentation of this file.
1 // Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
2 // SPDX-License-Identifier: BSD-3-Clause
3 //
4 // --------------------------------------------------------------------------
5 // $Maintainer: Hannes Roest $
6 // $Authors: Hannes Roest $
7 // --------------------------------------------------------------------------
8 
9 #pragma once
10 
11 #include <OpenMS/config.h>
13 #include <OpenMS/CONCEPT/Types.h>
14 
15 namespace OpenMS
16 {
17 
18 namespace Interfaces
19 {
20 
43  class OPENMS_DLLAPI IMSDataConsumer
44  {
45  public:
48 
49  virtual ~IMSDataConsumer() {}
50 
60  virtual void consumeSpectrum(SpectrumType & s) = 0;
61 
72 
85  virtual void setExpectedSize(size_t expectedSpectra, size_t expectedChromatograms) = 0;
86 
98  virtual void setExperimentalSettings(const ExperimentalSettings& exp) = 0;
99  };
100 
102 
103 } //end namespace Interfaces
104 } //end namespace OpenMS
105 
Description of the experimental settings.
Definition: ExperimentalSettings.h:36
The interface of a consumer of spectra and chromatograms.
Definition: IMSDataConsumer.h:44
MSChromatogram ChromatogramType
Definition: IMSDataConsumer.h:47
virtual ~IMSDataConsumer()
Definition: IMSDataConsumer.h:49
MSSpectrum SpectrumType
Definition: IMSDataConsumer.h:46
virtual void consumeSpectrum(SpectrumType &s)=0
Consume a spectrum.
virtual void consumeChromatogram(ChromatogramType &)=0
Consume a chromatogram.
virtual void setExpectedSize(size_t expectedSpectra, size_t expectedChromatograms)=0
Set expected size of spectra and chromatograms to be consumed.
virtual void setExperimentalSettings(const ExperimentalSettings &exp)=0
Set experimental settings (meta-data) of the data to be consumed.
The representation of a chromatogram.
Definition: MSChromatogram.h:31
The representation of a 1D spectrum.
Definition: MSSpectrum.h:44
IMSDataConsumer IMSDataConsumer
Definition: IMSDataConsumer.h:101
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:22