| OpenMS 2.5.0

MS2Feature.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: Lukas Mueller, Markus Mueller $
33 // --------------------------------------------------------------------------
34 //
36 //
37 // written by Lukas N Mueller, 30.3.05
38 // Lukas.Mueller@imsb.biol.ethz.ch
39 // Group of Prof. Ruedi Aebersold, IMSB, ETH Hoenggerberg, Zurich
40 //
41 // Ported to OpenMS by Florian Zeller, florian.zeller@bsse.ethz.ch
42 // December 2010
43 //
44
45 #pragma once
46
47 #include <OpenMS/TRANSFORMATIONS/FEATUREFINDER/SUPERHIRN/SuperHirnConfig.h>
48
49 #include <OpenMS/TRANSFORMATIONS/FEATUREFINDER/SUPERHIRN/MS2Fragment.h>
50 #include <OpenMS/TRANSFORMATIONS/FEATUREFINDER/SUPERHIRN/ClusteredMS2ConsensusSpectrum.h>
51
52 namespace OpenMS
53 {
54
55 class SUPERHIRN_DLLAPI MS2Feature :
56 public ClusteredMS2ConsensusSpectrum
57 {
58
59
60 using ClusteredMS2ConsensusSpectrum::operator=;
61
63 // declaration of the private members:
64
65 private:
66
67 int ID;
68
70 // declaration of the public members:
71
72 public:
73
74
75 // class destructor
76 ~MS2Feature();
77 // class constructor
78 MS2Feature() {}
79 MS2Feature(MS2Fragment *);
80 MS2Feature(double iPrecursorMZ, double iTR, int iChrg, int iApexScan);
81
82 // class copy constructor
83 MS2Feature(const MS2Feature &);
84 // class copy constructor
85 MS2Feature(const MS2Feature *);
86
87
89 // overload operators:
90 //MS2Feature& operator=(const MS2Feature&);
91 bool operator==(const MS2Feature &);
92 MS2Feature & operator<=(const MS2Feature &);
93 MS2Feature & operator>=(const MS2Feature &);
94 MS2Feature & operator<(const MS2Feature &);
95 MS2Feature & operator>(const MS2Feature &);
96
97
98 // show info
99 void show_info();
100
101
103 // start here all the get / set
104 // function to access the
105 // variables of the class
106
107 inline void setID(int in){ID = in; }
108 inline int getID(){return ID; }
109
110
111 };
112
113 } // ns
114
OpenMS::MS2Fragment
Definition: MS2Fragment.h:60
OpenMS::operator<
bool operator<(const MultiplexDeltaMasses &dm1, const MultiplexDeltaMasses &dm2)
OpenMS::MS2Feature::MS2Feature
MS2Feature()
Definition: MS2Feature.h:78
OpenMS::ClusteredMS2ConsensusSpectrum
Definition: ClusteredMS2ConsensusSpectrum.h:62
OpenMS::MS2Feature
Definition: MS2Feature.h:55
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
ClusteredMS2ConsensusSpectrum.h
OpenMS::MS2Feature::getID
int getID()
Definition: MS2Feature.h:108
OpenMS::MS2Feature::setID
void setID(int in)
Definition: MS2Feature.h:107
OpenMS::MS2Feature::ID
int ID
Definition: MS2Feature.h:67
MS2Fragment.h
KDTree::operator==
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806