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

Consumer class that passes all operations on to a set of consumers. More...

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

Inheritance diagram for MSDataChainingConsumer:
IMSDataConsumer< MSExperiment<> >

Public Member Functions

 MSDataChainingConsumer ()
 Default Constructor. More...
 
 MSDataChainingConsumer (std::vector< Interfaces::IMSDataConsumer<> * > consumers)
 Constructor. More...
 
 ~MSDataChainingConsumer ()
 Destructor. More...
 
void appendConsumer (Interfaces::IMSDataConsumer<> *consumer)
 Append a consumer to the chain of consumers to be executed. More...
 
void setExperimentalSettings (const ExperimentalSettings &settings)
 Set experimental settings for all consumers. More...
 
void setExpectedSize (Size s_size, Size c_size)
 Set expected size for all consumers. More...
 
void consumeSpectrum (SpectrumType &s)
 Call all consumers in the specified order for the given spectrum. More...
 
void consumeChromatogram (ChromatogramType &c)
 Call all consumers in the specified order for the given chromatogram. More...
 
- Public Member Functions inherited from IMSDataConsumer< MSExperiment<> >
virtual ~IMSDataConsumer ()
 

Private Attributes

std::vector< Interfaces::IMSDataConsumer<> * > consumers_
 

Additional Inherited Members

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

Detailed Description

Consumer class that passes all operations on to a set of consumers.

This consumer allows to chain multiple data consumers and applying them in a pre-specified order. This can be useful if a certain operation on a dataset needs to be performed but some pre-processing (data reduction etc.) or post-processing (writing to disk, caching on disk). The different processing steps can be added to the chaining consumer(in the correct order) without knowledge of the specific pre/post processing steps.

Constructor & Destructor Documentation

Default Constructor.

MSDataChainingConsumer ( std::vector< Interfaces::IMSDataConsumer<> * >  consumers)

Constructor.

Pass a list of consumers that should be called sequentially

Note
This does not transfers ownership - it is the callers responsibility to delete the pointer to consumer afterwards.

Destructor.

Member Function Documentation

void appendConsumer ( Interfaces::IMSDataConsumer<> *  consumer)

Append a consumer to the chain of consumers to be executed.

Note
This does not transfers ownership - it is the callers responsibility to delete the pointer to consumer afterwards.
void consumeChromatogram ( ChromatogramType c)
virtual

Call all consumers in the specified order for the given chromatogram.

Implements IMSDataConsumer< MSExperiment<> >.

void consumeSpectrum ( SpectrumType s)
virtual

Call all consumers in the specified order for the given spectrum.

Implements IMSDataConsumer< MSExperiment<> >.

void setExpectedSize ( Size  s_size,
Size  c_size 
)
virtual

Set expected size for all consumers.

Will set the expected size for all chained consumers

Implements IMSDataConsumer< MSExperiment<> >.

void setExperimentalSettings ( const ExperimentalSettings settings)
virtual

Set experimental settings for all consumers.

Will set the experimental settings for all chained consumers

Implements IMSDataConsumer< MSExperiment<> >.

Member Data Documentation

std::vector<Interfaces::IMSDataConsumer<> *> consumers_
private

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