OpenMS
IdentificationHit.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 
12 
13 namespace OpenMS
14 {
22  class OPENMS_DLLAPI IdentificationHit :
23  public MetaInfoInterface
24  {
25 public:
26 
28 
29 
35  virtual ~IdentificationHit();
38 
43 
45  bool operator==(const IdentificationHit & rhs) const;
47  bool operator!=(const IdentificationHit & rhs) const;
49 
51 
52  void setId(const String & id);
54 
56  const String & getId() const;
57 
59  void setCharge(Int charge);
60 
62  Int getCharge() const;
63 
65  void setCalculatedMassToCharge(double mz);
66 
68  double getCalculatedMassToCharge() const;
69 
71  void setExperimentalMassToCharge(double mz);
72 
75 
77  void setName(const String & name);
78 
80  const String & getName() const;
81 
83  void setPassThreshold(bool pass);
84 
86  bool getPassThreshold() const;
87 
89  void setRank(Int rank);
90 
92  Int getRank() const;
94 
95 
96 protected:
97 
105  };
106 
107 } //namespace OpenMS
108 
Represents a object which can store the information of an analysisXML instance.
Definition: IdentificationHit.h:24
double experimental_mass_to_charge_
experimental mass to charge ratio
Definition: IdentificationHit.h:101
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:102
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:100
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:103
Int rank_
rank of the peptide
Definition: IdentificationHit.h:104
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:98
void setRank(Int rank)
set the rank of the peptide
virtual ~IdentificationHit()
Destructor.
Int charge_
peptide charge
Definition: IdentificationHit.h:99
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:35
A more convenient string class.
Definition: String.h:34
int Int
Signed integer type.
Definition: Types.h:76
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:22