Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
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-2013.
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: Nico Pfeifer $
32 // $Authors: $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_METADATA_PROTEINHIT_H
36 #define OPENMS_METADATA_PROTEINHIT_H
37 
38 #include <vector>
39 
40 #include <OpenMS/CONCEPT/Types.h>
43 
44 namespace OpenMS
45 {
54  class OPENMS_DLLAPI ProteinHit :
55  public MetaInfoInterface
56  {
57 public:
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  if (a.getScore() != b.getScore())
69  {
70  return a.getScore() > b.getScore();
71  }
72  return a.getAccession() > b.getAccession();
73  }
74 
75  };
76 
78  class OPENMS_DLLAPI ScoreLess
79  {
80 public:
81  template <typename Arg>
82  bool operator()(const Arg & a, const Arg & b)
83  {
84  if (a.getScore() != b.getScore())
85  {
86  return a.getScore() < b.getScore();
87  }
88  return a.getAccession() < b.getAccession();
89  }
90 
91  };
93 
96 
98  ProteinHit();
99 
101  ProteinHit(DoubleReal score, UInt rank, String accession, String sequence);
102 
104  ProteinHit(const ProteinHit & source);
105 
107  virtual ~ProteinHit();
109 
111  ProteinHit & operator=(const ProteinHit & source);
112 
114  ProteinHit & operator=(const MetaInfoInterface & source);
115 
117  bool operator==(const ProteinHit & rhs) const;
118 
120  bool operator!=(const ProteinHit & rhs) const;
121 
122 
125 
127  Real getScore() const;
128 
130  UInt getRank() const;
131 
133  const String & getSequence() const;
134 
136  const String & getAccession() const;
137 
139  DoubleReal getCoverage() const;
140 
142  void setScore(const DoubleReal score);
143 
145  void setRank(UInt newrank);
146 
148  void setSequence(const String & sequence);
149 
151  void setAccession(const String & accession);
152 
154  void setCoverage(const DoubleReal coverage);
155 
157 
158 protected:
164 
165  };
166 
167 } // namespace OpenMS
168 
169 #endif // OPENMS_METADATA_PROTEINHIT_H
float Real
Real type.
Definition: Types.h:109
A more convenient string class.
Definition: String.h:56
Real score_
the score of the protein hit
Definition: ProteinHit.h:159
String sequence_
the amino acid sequence of the protein hit
Definition: ProteinHit.h:162
bool operator()(const Arg &a, const Arg &b)
Definition: ProteinHit.h:82
Lesser predicate for scores of hits.
Definition: ProteinHit.h:78
DoubleReal coverage_
coverage of the protein based upon the matched peptide sequences
Definition: ProteinHit.h:163
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:61
Representation of a protein hit.
Definition: ProteinHit.h:54
UInt rank_
the position(rank) where the hit appeared in the hit list
Definition: ProteinHit.h:160
bool operator()(const Arg &a, const Arg &b)
Definition: ProteinHit.h:66
String accession_
the protein identifier
Definition: ProteinHit.h:161

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:19 using doxygen 1.8.5