Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
PeptideEvidence.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: Andreas Bertsch $
32 // $Authors: Andreas Bertsch $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_METADATA_PEPTIDEEVIDENCE_H
36 #define OPENMS_METADATA_PEPTIDEEVIDENCE_H
37 
38 #include <vector>
39 
40 #include <OpenMS/CONCEPT/Types.h>
43 
44 namespace OpenMS
45 {
46  class AASequence;
47 
58  class OPENMS_DLLAPI PeptideEvidence :
59  public MetaInfoInterface
60  {
61 public:
62 
67 
70  UInt rank,
71  Int charge,
72  const AASequence & sequence);
73 
75  PeptideEvidence(const PeptideEvidence & source);
76 
78  virtual ~PeptideEvidence();
80 
82  PeptideEvidence & operator=(const PeptideEvidence & source);
83 
85  bool operator==(const PeptideEvidence & rhs) const;
86 
88  bool operator!=(const PeptideEvidence & rhs) const;
89 
93  const String & getDBSequenceRef() const;
95 
97  void setDBSequenceRef(const String & rhs);
98 
100  const String & getTranslationTableRef() const;
101 
103  void setTranslationTableRef(const String & rhs);
104 
106  void setStart(Int start);
107 
109  Int getStart() const;
110 
112  void setEnd(Int end);
113 
115  Int getEnd() const;
116 
118  void setPre(char rhs);
119 
121  char getPre() const;
122 
124  void setPost(char rhs);
125 
127  char getPost() const;
128 
130  void setId(const String & id);
131 
133  const String & getId() const;
134 
136  void setName(const String & name);
137 
139  const String & getName() const;
140 
142  void setMissedCleavages(Int rhs);
143 
145  Int getMissedCleavages() const;
146 
148  void setIsDecoy(bool is_decoy);
149 
151  bool getIsDecoy() const;
152 
154  void setFrame(Int frame);
155 
157  Int getFrame() const;
159 
160 
161 protected:
162 
167  char pre_;
168  char post_;
172  bool is_decoy_;
174 
175  };
176 
177 } // namespace OpenMS
178 
179 #endif // OPENMS_METADATA_PEPTIDEEVIDENCE_H
Int frame_
Definition: PeptideEvidence.h:173
A more convenient string class.
Definition: String.h:56
Int start_
Definition: PeptideEvidence.h:165
String id_
Definition: PeptideEvidence.h:169
String translation_table_ref_
Definition: PeptideEvidence.h:164
Representation of a peptide/protein sequence.
Definition: AASequence.h:84
String db_sequence_ref_
Definition: PeptideEvidence.h:163
String name_
Definition: PeptideEvidence.h:170
bool is_decoy_
Definition: PeptideEvidence.h:172
Representation of a MzIdentML PeptideEvidence.
Definition: PeptideEvidence.h:58
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:61
char pre_
Definition: PeptideEvidence.h:167
char post_
Definition: PeptideEvidence.h:168
Int end_
Definition: PeptideEvidence.h:166
Int missed_cleavages_
Definition: PeptideEvidence.h:171
int Int
Signed integer type.
Definition: Types.h:100

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