| OpenMS 2.5.0

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