Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
MSDataTransformingConsumer Class Reference

Transforming consumer of MS data. More...

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

Inheritance diagram for MSDataTransformingConsumer:
IMSDataConsumer<>

Public Types

typedef MSExperiment MapType
 
typedef MapType::SpectrumType SpectrumType
 
typedef MapType::ChromatogramType ChromatogramType
 
- Public Types inherited from IMSDataConsumer<>
typedef MSExperiment<>::SpectrumType SpectrumType
 
typedef MSExperiment<>::ChromatogramType ChromatogramType
 

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)
 
virtual void setSpectraProcessingPtr (void(*sproptr)(SpectrumType &))
 
virtual void consumeChromatogram (ChromatogramType &c)
 
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 ()
 
virtual void consumeSpectrum (SpectrumType &s)=0
 Consume a spectrum. More...
 
virtual void consumeChromatogram (ChromatogramType &)=0
 Consume a chromatogram. More...
 

Protected Attributes

void(* sprocessing_ptr_ )(SpectrumType &)
 
void(* cprocessing_ptr_ )(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.

Member Typedef Documentation

Constructor & Destructor Documentation

virtual ~MSDataTransformingConsumer ( )
inlinevirtual

Default destructor.

Member Function Documentation

virtual void consumeChromatogram ( ChromatogramType c)
inlinevirtual

References OpenMS::Constants::c.

virtual void consumeSpectrum ( SpectrumType s)
inlinevirtual
virtual void setChromatogramProcessingPtr ( void(*)(ChromatogramType &)  cproptr)
inlinevirtual
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
expectedSpectraNumber of spectra expected
expectedChromatogramsNumber of chromatograms expected

Implements IMSDataConsumer<>.

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
expExperimental settings meta data for the data to be consumed

Implements IMSDataConsumer<>.

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

Member Data Documentation

void(* cprocessing_ptr_) (ChromatogramType &)
protected
void(* sprocessing_ptr_) (SpectrumType &)
protected

OpenMS / TOPP release 2.0.0 Documentation generated on Sat May 16 2015 16:13:57 using doxygen 1.8.9.1