MSDataTransformingConsumer Class Reference

Transforming consumer of MS data. More...

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

Inheritance diagram for MSDataTransformingConsumer:

Public Member Functions
	MSDataTransformingConsumer ()
	Constructor. More...
virtual	~MSDataTransformingConsumer ()
	Default destructor. More...
virtual void	setExpectedSize (Size, Size)
	Set expected size of spectra and chromatograms to be consumed. More...
virtual void	consumeSpectrum (SpectrumType &s)
	Consume a spectrum. More...
virtual void	setSpectraProcessingPtr (void(*sproptr)(SpectrumType &))
virtual void	consumeChromatogram (ChromatogramType &c)
	Consume a chromatogram. More...
virtual void	setChromatogramProcessingPtr (void(*cproptr)(ChromatogramType &))
virtual void	setExperimentalSettings (const OpenMS::ExperimentalSettings &)
	Set experimental settings (meta-data) of the data to be consumed. More...
Public Member Functions inherited from IMSDataConsumer
virtual	~IMSDataConsumer ()

Protected Attributes
void(*	sprocessing_ptr_ )(SpectrumType &)
void(*	cprocessing_ptr_ )(ChromatogramType &)

Additional Inherited Members
Public Types inherited from IMSDataConsumer
typedef MSSpectrum	SpectrumType
typedef MSChromatogram	ChromatogramType

Detailed Description

Transforming consumer of MS data.

Is able to transform a spectra on the fly while it is read using a function pointer that can be set on the object.

Note that the spectrum gets transformed in-place.

Constructor & Destructor Documentation

MSDataTransformingConsumer()

MSDataTransformingConsumer ( )

inline

Constructor.

References OpenMS::FunctionChromatogramNOP(), and OpenMS::FunctionSpectrumNOP().

~MSDataTransformingConsumer()

virtual ~MSDataTransformingConsumer ( )

inlinevirtual

Default destructor.

Member Function Documentation

consumeChromatogram()

virtual void consumeChromatogram ( ChromatogramType &  )

inlinevirtual

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

s	The chromatogram to be consumed

Implements IMSDataConsumer.

References OpenMS::Constants::c.

consumeSpectrum()

virtual void consumeSpectrum ( SpectrumType &  s )

inlinevirtual

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

s	The spectrum to be consumed

Implements IMSDataConsumer.

setChromatogramProcessingPtr()

virtual void setChromatogramProcessingPtr ( void(*)(ChromatogramType &)  cproptr )

inlinevirtual

setExpectedSize()

virtual void setExpectedSize ( Size  expectedSpectra, Size  expectedChromatograms  )

inlinevirtual

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

expectedSpectra	Number of spectra expected
expectedChromatograms	Number of chromatograms expected

Implements IMSDataConsumer.

setExperimentalSettings()

virtual void setExperimentalSettings ( const OpenMS::ExperimentalSettings &  exp )

inlinevirtual

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

exp	Experimental settings meta data for the data to be consumed

Implements IMSDataConsumer.

setSpectraProcessingPtr()

virtual void setSpectraProcessingPtr ( void(*)(SpectrumType &)  sproptr )

inlinevirtual

Member Data Documentation

cprocessing_ptr_

void(* cprocessing_ptr_) (ChromatogramType &)

protected

sprocessing_ptr_

void(* sprocessing_ptr_) (SpectrumType &)

protected