Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Enzyme.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-2017.
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: Xiao Liang $
32 // $Authors: Xiao Liang $
33 // --------------------------------------------------------------------------
34 //
35 
36 #ifndef OPENMS_CHEMISTRY_ENZYME_H
37 #define OPENMS_CHEMISTRY_ENZYME_H
38 
41 
42 #include <iosfwd>
43 #include <set>
44 #include <vector>
45 
46 namespace OpenMS
47 {
48 
56  class OPENMS_DLLAPI Enzyme
57  {
58 public:
59 
63  Enzyme(const Enzyme& enzyme);
65 
67  explicit Enzyme(const String& name,
68  const String& cleavage_regex,
69  const std::set<String>& synonyms = std::set<String>(),
70  String regex_description = "",
71  EmpiricalFormula n_term_gain = EmpiricalFormula("H"),
72  EmpiricalFormula c_term_gain = EmpiricalFormula("OH"),
73  String psi_id = "",
74  String xtandem_id = "",
75  UInt comet_id = 0,
76  Int msgf_id = -1,
77  UInt omssa_id = 0);
78 
80  virtual ~Enzyme();
82 
86  Enzyme& operator=(const Enzyme& enzyme);
89 
93  void setName(const String& name);
95 
97  const String& getName() const;
98 
100  void setSynonyms(const std::set<String>& synonyms);
101 
103  void addSynonym(const String& synonym);
104 
106  const std::set<String>& getSynonyms() const;
107 
109  void setRegEx(const String& cleavage_regex);
110 
112  const String& getRegEx() const;
113 
115  void setRegExDescription(String value);
116 
118  String getRegExDescription() const;
119 
121  void setNTermGain(EmpiricalFormula value);
122 
124  EmpiricalFormula getNTermGain() const;
125 
127  void setCTermGain(EmpiricalFormula value);
128 
130  EmpiricalFormula getCTermGain() const;
131 
133  void setPSIID(String value);
134 
136  String getPSIID() const;
137 
139  void setXTandemID(String value);
140 
142  String getXTandemID() const;
143 
145  UInt getCometID() const;
146 
148  void setCometID(UInt value);
149 
151  void setMSGFID(Int value);
152 
154  Int getMSGFID() const;
155 
157  void setOMSSAID(UInt value);
158 
160  UInt getOMSSAID() const;
161 
163 
167  bool operator==(const Enzyme& enzyme) const;
169 
171  bool operator!=(const Enzyme& enzyme) const;
172 
174  bool operator==(String cleavage_regex) const;
175 
177  bool operator!=(String cleavage_regex) const;
178 
180  bool operator<(const Enzyme& enzyme) const;
182 
184  friend OPENMS_DLLAPI std::ostream & operator<<(std::ostream& os, const Enzyme& enzyme);
185 
186 protected:
188  Enzyme();
189 
190  // basic
192 
194 
195  std::set<String> synonyms_;
196 
198 
200 
202 
204 
206 
208 
210 
212 
213  };
214 
215  OPENMS_DLLAPI std::ostream& operator<<(std::ostream& os, const Enzyme& enzyme);
216 
217 }
218 
219 #endif
UInt omssa_id_
Definition: Enzyme.h:211
A more convenient string class.
Definition: String.h:57
EmpiricalFormula c_term_gain_
Definition: Enzyme.h:201
unsigned int UInt
Unsigned integer type.
Definition: Types.h:95
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
bool operator<(const MultiplexDeltaMasses &dm1, const MultiplexDeltaMasses &dm2)
Representation of an empirical formula.
Definition: EmpiricalFormula.h:80
String xtandem_id_
Definition: Enzyme.h:205
std::ostream & operator<<(std::ostream &os, const AccurateMassSearchResult &amsr)
String name_
Definition: Enzyme.h:191
Int msgf_id_
Definition: Enzyme.h:209
String cleavage_regex_
Definition: Enzyme.h:193
UInt comet_id_
Definition: Enzyme.h:207
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
Representation of an enzyme.
Definition: Enzyme.h:56
String psi_id_
Definition: Enzyme.h:203
String regex_description_
Definition: Enzyme.h:197
EmpiricalFormula n_term_gain_
Definition: Enzyme.h:199
int Int
Signed integer type.
Definition: Types.h:103
std::set< String > synonyms_
Definition: Enzyme.h:195

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:22:00 using doxygen 1.8.13