OpenMS
Loading...
Searching...
No Matches
IMSDataConsumer.h
Go to the documentation of this file.
1// Copyright (c) 2002-present, OpenMS Inc. -- 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
14namespace OpenMS
15{
16 class MSSpectrum;
17 class MSChromatogram;
18 class ExperimentalSettings;
19
20namespace Interfaces
21{
22
45 class OPENMS_DLLAPI IMSDataConsumer
46 {
47 public:
50
51 virtual ~IMSDataConsumer() {}
52
62 virtual void consumeSpectrum(SpectrumType& s) = 0;
63
74
87 virtual void setExpectedSize(size_t expectedSpectra, size_t expectedChromatograms) = 0;
88
100 virtual void setExperimentalSettings(const ExperimentalSettings& exp) = 0;
101 };
102
104
105} //end namespace Interfaces
106} //end namespace OpenMS
107
Description of the experimental settings.
Definition ExperimentalSettings.h:36
The interface of a consumer of spectra and chromatograms.
Definition IMSDataConsumer.h:46
MSChromatogram ChromatogramType
Definition IMSDataConsumer.h:49
virtual ~IMSDataConsumer()
Definition IMSDataConsumer.h:51
virtual void consumeChromatogram(ChromatogramType &c)=0
Consume a chromatogram.
MSSpectrum SpectrumType
Definition IMSDataConsumer.h:48
virtual void consumeSpectrum(SpectrumType &s)=0
Consume a spectrum.
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:30
The representation of a 1D spectrum.
Definition MSSpectrum.h:44
Main OpenMS namespace.
Definition openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19