Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Modification.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: Timo Sachsenberg $
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_METADATA_MODIFICATION_H
36 #define OPENMS_METADATA_MODIFICATION_H
37 
39 
41 
42 namespace OpenMS
43 {
52  class OPENMS_DLLAPI Modification :
53  public SampleTreatment
54  {
55 public:
58  {
59  AA
60  , AA_AT_CTERM
61  , AA_AT_NTERM
62  , CTERM
63  , NTERM
64  , SIZE_OF_SPECIFICITYTYPE
65  };
67  static const std::string NamesOfSpecificityType[SIZE_OF_SPECIFICITYTYPE];
68 
70  Modification();
72  Modification(const Modification &);
74  virtual ~Modification();
75 
77  Modification & operator=(const Modification &);
78 
85  virtual bool operator==(const SampleTreatment & rhs) const;
86 
88  virtual SampleTreatment * clone() const;
89 
91  const String & getReagentName() const;
93  void setReagentName(const String & reagent_name);
94 
96  double getMass() const;
98  void setMass(double mass);
99 
101  const SpecificityType & getSpecificityType() const;
103  void setSpecificityType(const SpecificityType & specificity_type);
104 
106  const String & getAffectedAminoAcids() const;
108  void setAffectedAminoAcids(const String & affected_amino_acids);
109 
110 protected:
112  double mass_;
115  };
116 } // namespace OpenMS
117 
118 #endif // OPENMS_METADATA_MODIFICATION_H
A more convenient string class.
Definition: String.h:57
Base class for sample treatments (Digestion, Modification, Tagging, ...)
Definition: SampleTreatment.h:52
String reagent_name_
Definition: Modification.h:111
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
double mass_
Definition: Modification.h:112
SpecificityType
specificity of the reagent.
Definition: Modification.h:57
Meta information about chemical modification of a sample.
Definition: Modification.h:52
String affected_amino_acids_
Definition: Modification.h:114
SpecificityType specificity_type_
Definition: Modification.h:113

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