OpenMS  2.4.0
IdentificationHit.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-2018.
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 
38 
39 namespace OpenMS
40 {
48  class OPENMS_DLLAPI IdentificationHit :
49  public MetaInfoInterface
50  {
51 public:
52 
54 
58  virtual ~IdentificationHit();
60  IdentificationHit(const IdentificationHit & source);
62  IdentificationHit & operator=(const IdentificationHit & source);
64  bool operator==(const IdentificationHit & rhs) const;
66  bool operator!=(const IdentificationHit & rhs) const;
68 
70 
71  void setId(const String & id);
73 
75  const String & getId() const;
76 
78  void setCharge(Int charge);
79 
81  Int getCharge() const;
82 
84  void setCalculatedMassToCharge(double mz);
85 
87  double getCalculatedMassToCharge() const;
88 
90  void setExperimentalMassToCharge(double mz);
91 
93  double getExperimentalMassToCharge() const;
94 
96  void setName(const String & name);
97 
99  const String & getName() const;
100 
102  void setPassThreshold(bool pass);
103 
105  bool getPassThreshold() const;
106 
108  void setRank(Int rank);
109 
111  Int getRank() const;
113 
114 
115 protected:
116 
124  };
125 
126 } //namespace OpenMS
A more convenient string class.
Definition: String.h:57
Int rank_
rank of the peptide
Definition: IdentificationHit.h:123
bool pass_threshold_
pass threshold
Definition: IdentificationHit.h:122
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
Int charge_
peptide charge
Definition: IdentificationHit.h:118
String name_
name
Definition: IdentificationHit.h:121
double experimental_mass_to_charge_
experimental mass to charge ratio
Definition: IdentificationHit.h:120
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:55
Represents a object which can store the information of an analysisXML instance.
Definition: IdentificationHit.h:48
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
String id_
identifier
Definition: IdentificationHit.h:117
int Int
Signed integer type.
Definition: Types.h:102
double calculated_mass_to_charge_
calculated mass to charge ratio
Definition: IdentificationHit.h:119