Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
FeatureFinderDefs.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: $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_TRANSFORMATIONS_FEATUREFINDER_FEATUREFINDERDEFS_H
36 #define OPENMS_TRANSFORMATIONS_FEATUREFINDER_FEATUREFINDERDEFS_H
37 
38 
43 
44 namespace OpenMS
45 {
46 
47  // forward declaration
48  class FeatureFinder;
49 
51  struct OPENMS_DLLAPI FeatureFinderDefs
52  {
55 
58 
61 
63  enum Flag {UNUSED, USED};
64 
66  class OPENMS_DLLAPI NoSuccessor :
68  {
69 public:
70  NoSuccessor(const char * file, int line, const char * function, const IndexPair & index) :
71  BaseException(file, line, function, "NoSuccessor", "no successor/predecessor"),
72  index_(index)
73  {
74  what_ = String("there is no successor/predecessor for the given Index: ") + index_.first + "/" + index_.second;
76  }
77 
78  virtual ~NoSuccessor() throw()
79  {
80  }
81 
82 protected:
83  IndexPair index_; // index without successor/predecessor
84  };
85  };
86 }
87 #endif // OPENMS_TRANSFORMATIONS_FEATUREFINDER_FEATUREFINDERDEFS_H
IsotopeCluster::IndexPair IndexPair
Index to peak consisting of two UInts (scan index / peak index)
Definition: FeatureFinderDefs.h:54
A more convenient string class.
Definition: String.h:57
std::pair< Size, Size > IndexPair
An index e.g. in an MSExperiment.
Definition: IsotopeCluster.h:48
Flag
Flags that indicate if a peak is already used in a feature.
Definition: FeatureFinderDefs.h:63
IndexPair index_
Definition: FeatureFinderDefs.h:83
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
The purpose of this struct is to provide definitions of classes and typedefs which are used throughou...
Definition: FeatureFinderDefs.h:51
static GlobalExceptionHandler & getInstance()
The accessor for the singleton. It also serves as a replacement for the constructor.
Definition: GlobalExceptionHandler.h:89
NoSuccessor(const char *file, int line, const char *function, const IndexPair &index)
Definition: FeatureFinderDefs.h:70
IsotopeCluster::IndexSet IndexSet
A set of peak indices.
Definition: FeatureFinderDefs.h:60
virtual ~NoSuccessor()
Definition: FeatureFinderDefs.h:78
Exception that is thrown if a method an invalid IndexPair is given.
Definition: FeatureFinderDefs.h:66
Exception base class.
Definition: Exception.h:90
IsotopeCluster::ChargedIndexSet ChargedIndexSet
Index to peak consisting of two UInts (scan index / peak index) with charge information.
Definition: FeatureFinderDefs.h:57
static void setMessage(const std::string &message)
index set with associated charge estimate
Definition: IsotopeCluster.h:53
std::set< IndexPair > IndexSet
A set of index pairs, usually referring to an MSExperiment.
Definition: IsotopeCluster.h:50

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