OpenMS
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-2023.
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 
55 
61  virtual ~IdentificationHit();
64 
69 
71  bool operator==(const IdentificationHit & rhs) const;
73  bool operator!=(const IdentificationHit & rhs) const;
75 
77 
78  void setId(const String & id);
80 
82  const String & getId() const;
83 
85  void setCharge(Int charge);
86 
88  Int getCharge() const;
89 
91  void setCalculatedMassToCharge(double mz);
92 
94  double getCalculatedMassToCharge() const;
95 
97  void setExperimentalMassToCharge(double mz);
98 
101 
103  void setName(const String & name);
104 
106  const String & getName() const;
107 
109  void setPassThreshold(bool pass);
110 
112  bool getPassThreshold() const;
113 
115  void setRank(Int rank);
116 
118  Int getRank() const;
120 
121 
122 protected:
123 
131  };
132 
133 } //namespace OpenMS
134 
Represents a object which can store the information of an analysisXML instance.
Definition: IdentificationHit.h:50
double experimental_mass_to_charge_
experimental mass to charge ratio
Definition: IdentificationHit.h:127
bool operator==(const IdentificationHit &rhs) const
Equality operator.
void setExperimentalMassToCharge(double mz)
sets the experimental mass to charge ratio
IdentificationHit()
Default constructor.
IdentificationHit(IdentificationHit &&)=default
Move constructor.
bool getPassThreshold() const
returns whether the peptide passed the threshold
IdentificationHit & operator=(IdentificationHit &&) &=default
Move assignment operator.
String name_
name
Definition: IdentificationHit.h:128
void setCalculatedMassToCharge(double mz)
sets the calculated mass to charge ratio
double getCalculatedMassToCharge() const
returns the calculated mass to charge ratio
const String & getId() const
returns the id
IdentificationHit & operator=(const IdentificationHit &)=default
Assignment operator.
Int getCharge() const
returns the charge state
double calculated_mass_to_charge_
calculated mass to charge ratio
Definition: IdentificationHit.h:126
void setName(const String &name)
sets the name
IdentificationHit(const IdentificationHit &)=default
Copy constructor.
Int getRank() const
returns the rank of the peptide
bool pass_threshold_
pass threshold
Definition: IdentificationHit.h:129
Int rank_
rank of the peptide
Definition: IdentificationHit.h:130
const String & getName() const
returns the name
bool operator!=(const IdentificationHit &rhs) const
Inequality operator.
double getExperimentalMassToCharge() const
returns the experimental mass to charge
void setCharge(Int charge)
sets the charge state of the peptide
void setPassThreshold(bool pass)
sets whether the peptide passed the threshold
String id_
identifier
Definition: IdentificationHit.h:124
void setRank(Int rank)
set the rank of the peptide
virtual ~IdentificationHit()
Destructor.
Int charge_
peptide charge
Definition: IdentificationHit.h:125
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:61
A more convenient string class.
Definition: String.h:60
int Int
Signed integer type.
Definition: Types.h:102
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48