Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
MSDataTransformingConsumer.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2015.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Hannes Roest $
32 // $Authors: Hannes Roest $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_FORMAT_DATAACCESS_MSDATATRANSFORMINGCONSUMER_H
36 #define OPENMS_FORMAT_DATAACCESS_MSDATATRANSFORMINGCONSUMER_H
37 
39 
40 namespace OpenMS
41 {
42 
46  OPENMS_DLLAPI extern void FunctionSpectrumNOP (MSSpectrum<Peak1D> & /* s */);
47 
51  OPENMS_DLLAPI extern void FunctionChromatogramNOP (MSChromatogram<ChromatogramPeak> & /* c */);
52 
59  class OPENMS_DLLAPI MSDataTransformingConsumer :
61  {
62 
63  public:
67 
72  {
73  sprocessing_ptr_ = &FunctionSpectrumNOP; // setting default processing action to noop
74  cprocessing_ptr_ = &FunctionChromatogramNOP; // setting default processing action to noop
75  }
76 
79 
80  virtual void setExpectedSize(Size /* expectedSpectra */, Size /* expectedChromatograms */)
81  {
82  // do nothing
83  }
84 
85  virtual void consumeSpectrum(SpectrumType & s)
86  {
87  // apply the given function to it
88  (*sprocessing_ptr_)(s);
89  }
90 
91  virtual void setSpectraProcessingPtr( void (*sproptr)(SpectrumType&) )
92  {
93  sprocessing_ptr_ = sproptr;
94  }
95 
96  virtual void consumeChromatogram(ChromatogramType & c)
97  {
98  // apply the given function to it
99  (*cprocessing_ptr_)(c);
100  }
101 
102  virtual void setChromatogramProcessingPtr( void (*cproptr)(ChromatogramType&) )
103  {
104  cprocessing_ptr_ = cproptr;
105  }
106 
108 
109  protected:
110  void (*sprocessing_ptr_)(SpectrumType&);
111  void (*cprocessing_ptr_)(ChromatogramType&);
112  };
113 
114 } //end namespace OpenMS
115 
116 #endif // OPENMS_FORMAT_DATAACCESS_MSDATATRANSFORMINGCONSUMER_H
void FunctionChromatogramNOP(MSChromatogram< ChromatogramPeak > &)
Empty (NOP) function.
virtual void setExpectedSize(Size, Size)
Set expected size of spectra and chromatograms to be consumed.
Definition: MSDataTransformingConsumer.h:80
virtual void consumeChromatogram(ChromatogramType &c)
Definition: MSDataTransformingConsumer.h:96
MSDataTransformingConsumer()
Constructor.
Definition: MSDataTransformingConsumer.h:71
void FunctionSpectrumNOP(MSSpectrum< Peak1D > &)
Empty (NOP) function.
const double c
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
MapType::ChromatogramType ChromatogramType
Definition: MSDataTransformingConsumer.h:66
MapType::SpectrumType SpectrumType
Definition: MSDataTransformingConsumer.h:65
virtual ~MSDataTransformingConsumer()
Default destructor.
Definition: MSDataTransformingConsumer.h:78
virtual void consumeSpectrum(SpectrumType &s)
Definition: MSDataTransformingConsumer.h:85
virtual void setSpectraProcessingPtr(void(*sproptr)(SpectrumType &))
Definition: MSDataTransformingConsumer.h:91
virtual void setChromatogramProcessingPtr(void(*cproptr)(ChromatogramType &))
Definition: MSDataTransformingConsumer.h:102
Transforming consumer of MS data.
Definition: MSDataTransformingConsumer.h:59
virtual void setExperimentalSettings(const OpenMS::ExperimentalSettings &)
Set experimental settings (meta-data) of the data to be consumed.
Definition: MSDataTransformingConsumer.h:107
MSExperiment MapType
Definition: MSDataTransformingConsumer.h:64
The interface of a consumer of spectra and chromatograms.
Definition: IMSDataConsumer.h:68
Description of the experimental settings.
Definition: ExperimentalSettings.h:59

OpenMS / TOPP release 2.0.0 Documentation generated on Fri May 29 2015 17:20:26 using doxygen 1.8.9.1