OpenMS  2.4.0
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-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: Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 
40 
41 namespace OpenMS
42 {
51  class OPENMS_DLLAPI Modification :
52  public SampleTreatment
53  {
54 public:
57  {
58  AA
59  , AA_AT_CTERM
60  , AA_AT_NTERM
61  , CTERM
62  , NTERM
63  , SIZE_OF_SPECIFICITYTYPE
64  };
66  static const std::string NamesOfSpecificityType[SIZE_OF_SPECIFICITYTYPE];
67 
69  Modification();
71  Modification(const Modification &);
73  ~Modification() override;
74 
76  Modification & operator=(const Modification &);
77 
84  bool operator==(const SampleTreatment & rhs) const override;
85 
87  SampleTreatment * clone() const override;
88 
90  const String & getReagentName() const;
92  void setReagentName(const String & reagent_name);
93 
95  double getMass() const;
97  void setMass(double mass);
98 
100  const SpecificityType & getSpecificityType() const;
102  void setSpecificityType(const SpecificityType & specificity_type);
103 
105  const String & getAffectedAminoAcids() const;
107  void setAffectedAminoAcids(const String & affected_amino_acids);
108 
109 protected:
111  double mass_;
114  };
115 } // namespace OpenMS
116 
A more convenient string class.
Definition: String.h:57
Base class for sample treatments (Digestion, Modification, Tagging, ...)
Definition: SampleTreatment.h:51
String reagent_name_
Definition: Modification.h:110
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
double mass_
Definition: Modification.h:111
SpecificityType
specificity of the reagent.
Definition: Modification.h:56
Meta information about chemical modification of a sample.
Definition: Modification.h:51
String affected_amino_acids_
Definition: Modification.h:113
SpecificityType specificity_type_
Definition: Modification.h:112