Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
BaseGroupFinder.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-2017.
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: Timo Sachsenberg $
32 // $Authors: Clemens Groepl, Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_ANALYSIS_MAPMATCHING_BASEGROUPFINDER_H
36 #define OPENMS_ANALYSIS_MAPMATCHING_BASEGROUPFINDER_H
37 
41 
42 #include <utility>
43 #include <fstream>
44 
45 namespace OpenMS
46 {
47 
62  class OPENMS_DLLAPI BaseGroupFinder :
63  public DefaultParamHandler,
64  public ProgressLogger
65  {
66 public:
69 
71  virtual ~BaseGroupFinder();
72 
78  virtual void run(const std::vector<ConsensusMap> & input, ConsensusMap & result) = 0;
79 
81  static void registerChildren();
82 
83 protected:
84 
90  void checkIds_(const std::vector<ConsensusMap> & maps) const;
91 
92 private:
93 
96 
98  BaseGroupFinder & operator=(const BaseGroupFinder &);
99 
100  };
101 
102 } // namespace OpenMS
103 
104 #endif // OPENMS_ANALYSIS_MAPMATCHING_BASEGROUPFINDER_H
A container for consensus elements.
Definition: ConsensusMap.h:72
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
The base class of all element group finding algorithms.
Definition: BaseGroupFinder.h:62
Base class for all classes that want to report their progress.
Definition: ProgressLogger.h:55
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:92

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:21:59 using doxygen 1.8.13