OpenMS  2.4.0
ProteinHit.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 
37 #include <vector>
38 
39 #include <OpenMS/CONCEPT/Types.h>
42 
43 namespace OpenMS
44 {
53  class OPENMS_DLLAPI ProteinHit :
54  public MetaInfoInterface
55  {
56 public:
57  static const double COVERAGE_UNKNOWN; // == -1
58 
60 
61  class OPENMS_DLLAPI ScoreMore
63  {
64 public:
65  template <typename Arg>
66  bool operator()(const Arg & a, const Arg & b)
67  {
68 #pragma clang diagnostic push
69 #pragma clang diagnostic ignored "-Wfloat-equal"
70  if (a.getScore() != b.getScore())
71 #pragma clang diagnostic pop
72  {
73  return a.getScore() > b.getScore();
74  }
75  return a.getAccession() > b.getAccession();
76  }
77 
78  };
79 
81  class OPENMS_DLLAPI ScoreLess
82  {
83 public:
84  template <typename Arg>
85  bool operator()(const Arg & a, const Arg & b)
86  {
87 #pragma clang diagnostic push
88 #pragma clang diagnostic ignored "-Wfloat-equal"
89  if (a.getScore() != b.getScore())
90 #pragma clang diagnostic pop
91  {
92  return a.getScore() < b.getScore();
93  }
94  return a.getAccession() < b.getAccession();
95  }
96 
97  };
99 
102 
104  ProteinHit();
105 
107  ProteinHit(double score, UInt rank, String accession, String sequence);
108 
110  ProteinHit(const ProteinHit & source);
111 
113  virtual ~ProteinHit();
115 
117  ProteinHit & operator=(const ProteinHit & source);
118 
120  ProteinHit & operator=(const MetaInfoInterface & source);
121 
123  bool operator==(const ProteinHit & rhs) const;
124 
126  bool operator!=(const ProteinHit & rhs) const;
127 
128 
131 
133  float getScore() const;
134 
136  UInt getRank() const;
137 
139  const String & getSequence() const;
140 
142  const String & getAccession() const;
143 
145  String getDescription() const;
146 
148  double getCoverage() const;
149 
151  void setScore(const double score);
152 
154  void setRank(UInt newrank);
155 
157  void setSequence(const String & sequence);
158 
160  void setAccession(const String & accession);
161 
163  void setDescription(const String & description);
164 
166  void setCoverage(const double coverage);
167 
169 
170 protected:
171  float score_;
175  double coverage_;
176 
177  };
178 
179 } // namespace OpenMS
180 
static const double COVERAGE_UNKNOWN
Definition: ProteinHit.h:57
A more convenient string class.
Definition: String.h:57
float score_
the score of the protein hit
Definition: ProteinHit.h:171
String sequence_
the amino acid sequence of the protein hit
Definition: ProteinHit.h:174
bool operator()(const Arg &a, const Arg &b)
Definition: ProteinHit.h:85
unsigned int UInt
Unsigned integer type.
Definition: Types.h:94
Lesser predicate for scores of hits.
Definition: ProteinHit.h:81
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
double coverage_
coverage of the protein based upon the matched peptide sequences
Definition: ProteinHit.h:175
Greater predicate for scores of hits.
Definition: ProteinHit.h:62
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:55
Representation of a protein hit.
Definition: ProteinHit.h:53
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
UInt rank_
the position(rank) where the hit appeared in the hit list
Definition: ProteinHit.h:172
bool operator()(const Arg &a, const Arg &b)
Definition: ProteinHit.h:66
String accession_
the protein identifier
Definition: ProteinHit.h:173