OpenMS  2.8.0
Public Member Functions | List of all members
NoopMSDataConsumer Class Reference

Consumer class that performs no operation. More...

#include <OpenMS/FORMAT/DATAACCESS/NoopMSDataConsumer.h>

Inheritance diagram for NoopMSDataConsumer:
[legend]
Collaboration diagram for NoopMSDataConsumer:
[legend]

Public Member Functions

 NoopMSDataConsumer ()
 
void setExperimentalSettings (const ExperimentalSettings &) override
 Set experimental settings (meta-data) of the data to be consumed. More...
 
void setExpectedSize (Size, Size) override
 Set expected size of spectra and chromatograms to be consumed. More...
 
void consumeSpectrum (SpectrumType &) override
 Consume a spectrum. More...
 
void consumeChromatogram (ChromatogramType &) override
 Consume a chromatogram. More...
 
- Public Member Functions inherited from IMSDataConsumer
virtual ~IMSDataConsumer ()
 

Additional Inherited Members

- Public Types inherited from IMSDataConsumer
typedef MSSpectrum SpectrumType
 
typedef MSChromatogram ChromatogramType
 

Detailed Description

Consumer class that performs no operation.

This is sometimes necessary to fulfill the requirement of passing an valid Interfaces::IMSDataConsumer object or pointer but no operation is required.

Constructor & Destructor Documentation

◆ NoopMSDataConsumer()

NoopMSDataConsumer ( )
inline

Member Function Documentation

◆ consumeChromatogram()

void consumeChromatogram ( ChromatogramType )
inlineoverridevirtual

Consume a chromatogram.

The chromatogram will be consumed by the implementation and possibly modified.

Note
The implementation might not allow to consume spectra and chromatograms in any order
Parameters
sThe chromatogram to be consumed

Implements IMSDataConsumer.

◆ consumeSpectrum()

void consumeSpectrum ( SpectrumType s)
inlineoverridevirtual

Consume a spectrum.

The spectrum will be consumed by the implementation and possibly modified.

Note
The implementation might not allow to consume spectra and chromatograms in any order
Parameters
sThe spectrum to be consumed

Implements IMSDataConsumer.

◆ setExpectedSize()

void setExpectedSize ( Size  expectedSpectra,
Size  expectedChromatograms 
)
inlineoverridevirtual

Set expected size of spectra and chromatograms to be consumed.

Some implementations might care about the number of spectra and chromatograms to be consumed and need to be informed about this (usually before consuming starts).

Note
Calling this method is optional but good practice.
Parameters
expectedSpectraNumber of spectra expected
expectedChromatogramsNumber of chromatograms expected

Implements IMSDataConsumer.

◆ setExperimentalSettings()

void setExperimentalSettings ( const ExperimentalSettings exp)
inlineoverridevirtual

Set experimental settings (meta-data) of the data to be consumed.

Some implementations might need to know about the meta-data (or the context) of the spectra and chromatograms to be consumed. This method allows them learn this.

Note
Calling this method is optional but good practice.
Parameters
expExperimental settings meta data for the data to be consumed

Implements IMSDataConsumer.