OpenMS
FeatureFinderDefs.h
Go to the documentation of this file.
1 // Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
2 // SPDX-License-Identifier: BSD-3-Clause
3 //
4 // --------------------------------------------------------------------------
5 // $Maintainer: Timo Sachsenberg $
6 // $Authors: $
7 // --------------------------------------------------------------------------
8 
9 #pragma once
10 
11 
16 
17 namespace OpenMS
18 {
19 
20  // forward declaration
21  class FeatureFinder;
22 
24  struct OPENMS_DLLAPI FeatureFinderDefs
25  {
28 
31 
34 
36  enum Flag {UNUSED, USED};
37 
39  class OPENMS_DLLAPI NoSuccessor :
41  {
42 public:
43  NoSuccessor(const char * file, int line, const char * function, const IndexPair & index) :
44  BaseException(file, line, function, "NoSuccessor", String("there is no successor/predecessor for the given Index: ") + String(index.first) + "/" + String(index.second)),
45  index_(index)
46  {
48  }
49 
50  ~NoSuccessor() noexcept override = default;
51 
52 protected:
53  IndexPair index_; // index without successor/predecessor
54  };
55  };
56 }
Exception base class.
Definition: Exception.h:65
static void setMessage(const std::string &message)
Exception that is thrown if a method an invalid IndexPair is given.
Definition: FeatureFinderDefs.h:41
~NoSuccessor() noexcept override=default
NoSuccessor(const char *file, int line, const char *function, const IndexPair &index)
Definition: FeatureFinderDefs.h:43
A more convenient string class.
Definition: String.h:34
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:22
The purpose of this struct is to provide definitions of classes and typedefs which are used throughou...
Definition: FeatureFinderDefs.h:25
Flag
Flags that indicate if a peak is already used in a feature.
Definition: FeatureFinderDefs.h:36
IsotopeCluster::IndexPair IndexPair
Index to peak consisting of two UInts (scan index / peak index)
Definition: FeatureFinderDefs.h:27
IsotopeCluster::ChargedIndexSet ChargedIndexSet
Index to peak consisting of two UInts (scan index / peak index) with charge information.
Definition: FeatureFinderDefs.h:30
IsotopeCluster::IndexSet IndexSet
A set of peak indices.
Definition: FeatureFinderDefs.h:33
index set with associated charge estimate
Definition: IsotopeCluster.h:28
std::pair< Size, Size > IndexPair
An index e.g. in an MSExperiment.
Definition: IsotopeCluster.h:21
std::set< IndexPair > IndexSet
A set of index pairs, usually referring to an MSExperiment.
Definition: IsotopeCluster.h:23